Skip to content

Commit 6fc9d28

Browse files
authored
Describe how a repo is released when a tag is pushed. (#132)
It is no longer necessary to manually create releases in the Github GUI or via `gh release create`. Signed-off-by: Dean Roehrich <dean.roehrich@hpe.com>
1 parent aaae493 commit 6fc9d28

1 file changed

Lines changed: 2 additions & 13 deletions

File tree

docs/repo-guides/release-nnf-sw/readme.md

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ Request, **you must use a Merge Commit.**
109109
treat everything like a conflict. Additionally, this will cause auto-generated release notes
110110
to include the previous release.
111111
112-
7. Once merged, update the release branch locally and create an annotated tag:
112+
7. Once merged, update the release branch locally and create an annotated tag. Each repo has a workflow job named `create_release` that will create a release automatically when the new tag is pushed.
113113
114114
```shell
115115
git checkout releases/v0
@@ -118,16 +118,7 @@ Request, **you must use a Merge Commit.**
118118
git push origin --tags
119119
```
120120
121-
8. Now that a tag exists, a release can be created via the [GitHub CLI](https://cli.github.com/).
122-
Alternatively, use the [Web UI](https://github.com/NearNodeFlash/nnf-dm/releases/new).
123-
124-
```bash
125-
gh release create --generate-notes --verify-tag -p v0.0.3 -t "Release v0.0.3"
126-
```
127-
128-
**Note** Do not do this `gh release create` in the nnf-deploy repo. That repo will create a release automatically when a new tag is pushed.
129-
130-
9. GOTO Step 1 and repeat this process for each remaining component.
121+
8. GOTO Step 1 and repeat this process for each remaining component.
131122
132123
## Release `nnf-deploy`
133124
@@ -192,8 +183,6 @@ that everything is current on `master` for `nnf-deploy`.
192183

193184
12. Follow steps 6-7 from the previous section to finalize the release of `nnf-deploy`.
194185

195-
**Note** In step 7, the push of the tag will cause nnf-deploy's `handle_release_tag` workflow to automatically create the release.
196-
197186
**The software is now released!**
198187

199188
## Clone a release

0 commit comments

Comments
 (0)