Skip to content

Commit

Permalink
Add releasing docs and release GitHub workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
pellared committed Apr 12, 2024
1 parent bf8aa2d commit 9f1db3f
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
18 changes: 18 additions & 0 deletions .github/workflows/release.yml
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
15 changes: 15 additions & 0 deletions RELEASING.md
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.

0 comments on commit 9f1db3f

Please sign in to comment.