Skip to content

Commit a84be0c

Browse files
ouphiMandur
andauthored
Add documentation about release creation. (#1960)
* Document release creation. * Improved doc. * markdownlint. * Improved description. * markdownlint. * Fix. * Update explanations. * Improved title descriptions. Co-authored-by: Mikhail Chatillon <chmikhai@microsoft.com>
1 parent 1d046ad commit a84be0c

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,3 +117,23 @@ Refer to the [Dev Guide][devguide] for development and debugging instructions.
117117
[knownissues]: https://azure.github.io/iotedge-lorawan-starterkit/dev/issues/
118118
[partnerinstructions]: https://azure.github.io/iotedge-lorawan-starterkit/dev/user-guide/partner/
119119
[specificationsupport]: https://azure.github.io/iotedge-lorawan-starterkit/dev/#lorawan-specification-support
120+
121+
## Create a release
122+
123+
You can create a release with the following steps:
124+
125+
### Run the Release workflow to create a draft release
126+
127+
Go to the [Create draft release workflow](https://github.com/Azure/iotedge-lorawan-starterkit/actions/workflows/create_release.yaml) and specify the release version before running the workflow.
128+
129+
### Merge 2 PRs
130+
131+
The Prerelease workflow will create 2 PRs, one PR to update the Starter Kit version in Bicep and one PR to update the Button URL. Merge these 2 PRs.
132+
133+
### Update master
134+
135+
Push dev branch to master
136+
137+
### Add a release description and publish the release
138+
139+
In Github, select the release created by the workflow, add a good description, and publish the release.

0 commit comments

Comments
 (0)