Skip to content

Commit 1a06053

Browse files
committed
Document release process
1 parent 03ec9e0 commit 1a06053

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,29 @@ Building, testing, and packing this repository can be done by using the standard
4141

4242
[pwsh]: https://docs.microsoft.com/powershell/scripting/install/installing-powershell?view=powershell-6
4343

44+
## Releases
45+
46+
Use `nbgv tag` to create a tag for a particular commit that you mean to release.
47+
[Learn more about `nbgv` and its `tag` and `prepare-release` commands](https://github.com/dotnet/Nerdbank.GitVersioning/blob/main/doc/nbgv-cli.md).
48+
49+
Push the tag.
50+
51+
### GitHub Actions
52+
53+
When your repo is hosted by GitHub and you are using GitHub Actions, you should create a GitHub Release using the standard GitHub UI.
54+
Having previously used `nbgv tag` and pushing the tag will help you identify the precise commit and name to use for this release.
55+
56+
After publishing the release, the `.github\workflows\release.yml` workflow will be automatically triggered, which will:
57+
58+
1. Find the most recent `.github\workflows\build.yml` GitHub workflow run of the tagged release.
59+
1. Upload the `deployables` artifact from that workflow run to your GitHub Release.
60+
1. If you have `NUGET_API_KEY` defined as a secret variable for your repo or org, any nuget packages in the `deployables` artifact will be pushed to nuget.org.
61+
62+
### Azure Pipelines
63+
64+
When your repo builds with Azure Pipelines, use the `azure-pipelines/release.yml` pipeline.
65+
Trigger the pipeline by adding the `auto-release` tag on a run of your main `azure-pipelines.yml` pipeline.
66+
4467
## Tutorial and API documentation
4568

4669
API and hand-written docs are found under the `docfx/` directory. and are built by [docfx](https://dotnet.github.io/docfx/).

0 commit comments

Comments
 (0)