-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: add
DEVELOPMENT.md
and release instructions (#90)
- Loading branch information
Showing
2 changed files
with
52 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# Release Process | ||
|
||
Pick a new version: | ||
|
||
```sh | ||
export NEW_VERSION="v1.x.x" | ||
``` | ||
|
||
Update all version strings: | ||
|
||
```sh | ||
make version-bump version=${NEW_VERSION} | ||
``` | ||
|
||
Update `CHANGELOG.md`: | ||
|
||
```sh | ||
make changelog tag=${NEW_VERSION} | ||
``` | ||
|
||
Check changes and commit/push: | ||
|
||
```sh | ||
git status | ||
git add . | ||
git commit -m "chore: bump version to ${NEW_VERSION}" | ||
``` | ||
|
||
You should see something similar to: | ||
|
||
```console | ||
On branch feat/foobar | ||
Changes not staged for commit: | ||
(use "git add <file>..." to update what will be committed) | ||
(use "git restore <file>..." to discard changes in working directory) | ||
modified: CHANGELOG.md | ||
modified: Makefile | ||
modified: README.md | ||
modified: cmd/pretender/main.go | ||
``` | ||
|
||
Create a new GitHub release using the value in `${NEW_VERSION}` as name and tag. The new release will trigger the automation to upload the binaries and push a docker image to DockerHub. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters