-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add releasing docs and release GitHub workflow
- Loading branch information
Showing
2 changed files
with
33 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,18 @@ | ||
name: release | ||
|
||
on: | ||
push: | ||
tags: [ 'v*' ] | ||
|
||
permissions: | ||
contents: read | ||
|
||
jobs: | ||
godoc: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Wait 1 minute | ||
# make sure that new the tag is available for pkg.go.dev | ||
run: sleep 60 | ||
- name: Update pkg.go.dev | ||
run: curl https://proxy.golang.org/github.com/${{ github.repository }}/@v/${{ github.ref_name }}.info |
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,15 @@ | ||
# Release Process | ||
|
||
1. Add and push a signed tag: | ||
|
||
```sh | ||
TAG='v<version>' | ||
COMMIT='<commit-sha>' | ||
git tag -s -m $TAG $TAG $COMMIT | ||
git push upstream $TAG | ||
``` | ||
|
||
1. Create a GitHib Release named `<version>` with `v<version>` tag. | ||
|
||
The release description should include all the release notes | ||
from the [`CHANGELOG.md`](CHANGELOG.md) for this release. |