Skip to content

Commit

Permalink
Merge pull request #1365 from Nordix/tuomo/fix-releasing-doc
Browse files Browse the repository at this point in the history
📖 fix releasing.md on annotated tags
  • Loading branch information
metal3-io-bot authored Sep 26, 2023
2 parents 137006a + 9714d1e commit 97abcb2
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,12 +81,12 @@ We also need to create one or more tags for the Go modules ecosystem:

- For any subdirectory with `go.mod` in it (excluding `hack/tools`), create
another Git tag with directory prefix, ie.
`git tag -s apis/v0.x.y -m apis/v0.x.y`.
`git tag -s apis/v0.x.y`.
For BMO, these directories are `apis` and `pkg/hardwareutils`. This enables
the tags to be used as a Go module version for any downstream users.
**NOTE**: Do not create annotated tags for Go modules. Release notes expects
only the main tag to be annotated, otherwise it might create incorrect
release notes.
**NOTE**: Do not create annotated tags (`-a` or `-m`) for Go modules. Release
notes expects only the main tag to be annotated, otherwise it might create
incorrect release notes.

### Release artifacts

Expand Down

0 comments on commit 97abcb2

Please sign in to comment.