Skip to content

Commit 86ad0af

Browse files
committed
docs: upgrades to releasing.md advised by @Stef3st
Signed-off-by: Juan Muñoz <[email protected]>
1 parent 5aa5245 commit 86ad0af

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

RELEASING.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,23 @@
2222

2323
`git fetch upstream`
2424

25-
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*
25+
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 like *release_v0_33_0_1*:
26+
27+
`git checkout 5aa52454f3e3bb88efef7c8fb466d4d3cc48d20d -b release_v0_33_0_1` (example with commit hash)
28+
29+
or
30+
31+
`git checkout upstream/main -b release_v0_33_0_1` (example using open-scd's main branch)
32+
2633
4. Merge changes from *origin/main* into your release branch like this:
2734
2835
`git merge main --strategy recursive`
2936
3037
5. Make sure tests are passing, add fixes for breaking changes from **open-scd**
3138
6. Update the version number in your project's `package.json` file.
32-
7. Create a PR from your release branch into *main*
33-
8. Create a new release on GitHub and tag it with the new version number.
34-
9. Include automatic release notes summarizing the changes in this release.
35-
10. Publish the release and update all the CoMPAS projects with a dependency on this repo to the newly released version.
39+
7. Push the changes in your release branch to origin:
40+
`git push --set-upstream origin release_v0_33_0_1`
41+
8. Create a PR from your release branch into *main*
42+
9. Create a new release on GitHub and tag it with the new version number.
43+
10. Include automatic release notes summarizing the changes in this release.
44+
11. Publish the release and update all the CoMPAS projects with a dependency on this repo to the newly released version.

0 commit comments

Comments
 (0)