Skip to content

Commit

Permalink
Improve narration and discuss use of internal in RELEASE.md (#181)
Browse files Browse the repository at this point in the history
* remind ourselves to look at  and some version bumps to improve the narrative flow of the document

---------

Signed-off-by: Steve Jenson <[email protected]>
  • Loading branch information
Steve Jenson authored Feb 14, 2023
1 parent 4589268 commit fe90a87
Showing 1 changed file with 16 additions and 5 deletions.
21 changes: 16 additions & 5 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,24 +13,35 @@ The Tag identifier format is:
## Step 1: Prepare an appropriate log message for the release

Take a look at the changes from the last release to now within the project
subdirectory you're going to release from.
subdirectory you're going to release from as well as `internal` if the project
relies on code living there.

`git log v2.0.0..HEAD -p proxy-init`
`git log proxy-init/v2.1.0..HEAD -p proxy-init`
`git log proxy-init/v2.1.0..HEAD -p internal`

Prepare a commit message. For each meaningful commit since the last tag, add
a single line. Use `git show` on another release tag to see the format we use.
a single line. See `git show proxy-init/v2.2.0` as an example the format we use.

Note: currently `validator` doesn't rely on `internal`, while `cni-plugin` and
`proxy-init` do.

## Step 2: Tag the release

`git tag -a proxy-init/v2.1.0`
First, find the current latest version tag for the subproject

`git tag -l 'proxy-init/*' --sort=-"v:refname" | head -n 1`

Increase the version with a major, minor, or patch according to the changes made

`git tag -a proxy-init/v2.x.x`

For the commit message, use what you created in Step 1.

## Step 3: Push the tag

By default in git, tags are local so we'll need to push the tag to `origin`.

`git push origin proxy-init/v2.1.0`
`git push origin proxy-init/v2.2.0`

There you go, a release should be running in github, you can check the Actions
page.
Expand Down

0 comments on commit fe90a87

Please sign in to comment.