You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/ContributingCode.md
+12-5Lines changed: 12 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -68,11 +68,18 @@ There are 3 types of static analysis that are enforced on every PR:
68
68
## Publishing a Release
69
69
Only repo maintainers can publish a release. The process is kicked off by pushing a tag in the format `v0.7`. We follow [Semantic Versioning](https://semver.org/) when deciding on the next version number.
70
70
71
-
This will trigger an Actions workflow that results in a new release being published. It performs these steps:
72
-
- Validates that the SHA referenced by the tag is in the history of the `main` branch
73
-
- Runs `publish.ps1` to build self-contained binaries for each platform. This script also embeds the version number (extracted from the tag) into each binary.
74
-
- Creates a release in this repo with the self-contained binaries, uses the contents of `RELEASENOTES.md` as the release description.
75
-
- Moves the contents of `RELEASENOTES.md` to a version specific file under the releasenotes folder, then empties out `RELEASENOTES.md` and commits the 2 files
71
+
### How to publish a release
72
+
73
+
1. Check [`RELEASENOTES.md`](http://releasenotes.md/) to see if there is anything to release.
74
+
2. Switch to the `main` branch and `pull` the latest.
75
+
3. *optional* List the tags e.g. `git tag`
76
+
4. Tag the version e.g. `git tag v5.0`
77
+
5. Push the tags up e.g. `git push --tags`
78
+
6. This will trigger an Actions workflow that results in a new release being published, once the build is done it will wait for approval(from maintainers) in order to `pushlish` the binaries. The workflow does the following steps:
79
+
- Validates that the SHA referenced by the tag is in the history of the `main` branch
80
+
- Runs `publish.ps1` to build self-contained binaries for each platform. This script also embeds the version number (extracted from the tag) into each binary.
81
+
- Creates a release in this repo with the self-contained binaries, uses the contents of `RELEASENOTES.md` as the release description.
82
+
- Moves the contents of `[RELEASENOTES.md](http://RELEASENOTES.md)` to a version specific file under the name of the created `tag` in the releasenotes folder, then empties out `RELEASENOTES.md` and commits the 2 files.
0 commit comments