Skip to content

Commit 178372b

Browse files
authored
Merge pull request #1224 from github/update-release-docs
Update publish release docs
2 parents d00f295 + 6915065 commit 178372b

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

docs/ContributingCode.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,18 @@ There are 3 types of static analysis that are enforced on every PR:
6868
## Publishing a Release
6969
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.
7070
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.
7683
7784
## Development Basics
7885

0 commit comments

Comments
 (0)