Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Release guide for this fork #258

Conversation

juancho0202
Copy link

@juancho0202 juancho0202 commented Aug 30, 2023

Closes #255

UPDATING.md is not needed anymore

Signed-off-by: Juan Munoz <juancho0202@gmail.com>
@juancho0202 juancho0202 removed the request for review from Sander3003 August 30, 2023 12:01
Copy link

@Stef3st Stef3st left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, clear steps and easy to follow! Ive added a few suggestions to make the steps a bit more clear.

RELEASING.md Outdated

`git fetch upstream`

3. Create a new release branch from the latest release of open-scd (this could be *upstream/main* if it was just released or the specific commit hash of the release), using a branch name relative to the desired release tag, example: *release_v0_33_0_1*
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could maybe specify the git command? Like for example: git checkout *hash* -b release_v0_33_0_1

RELEASING.md Outdated

5. Make sure tests are passing, add fixes for breaking changes from **open-scd**
6. Update the version number in your project's `package.json` file.
7. Create a PR from your release branch into *main*
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Before creating a PR the branch first needs to be merged. Command could be for example: git push --set-upstream origin release_v0_33_0_1

Signed-off-by: Juan Muñoz <juan.munoz@alliander.com>
@juancho0202 juancho0202 requested review from Stef3st and removed request for pascalwilbrink September 4, 2023 12:00
Copy link

@Stef3st Stef3st left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

@juancho0202 juancho0202 merged commit 71b9b18 into main Sep 6, 2023
6 checks passed
@juancho0202 juancho0202 deleted the 255-document-the-process-of-updating-to-a-new-version-of-openscd-from-this-fork branch September 6, 2023 07:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Document the process of updating to a new version of OpenSCD from this fork
2 participants