Skip to content

Commit

Permalink
Add in release github action
Browse files Browse the repository at this point in the history
Signed-off-by: Matthew B White <[email protected]>
  • Loading branch information
mbwhite authored and ale-linux committed Oct 21, 2022
1 parent 29f75a0 commit 4757feb
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 1 deletion.
7 changes: 7 additions & 0 deletions .github/workflows/go.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ name: Go
on:
push:
branches: [ main ]
tags: [ v** ]
pull_request:
branches: [ main ]
workflow_dispatch:
Expand Down Expand Up @@ -37,3 +38,9 @@ jobs:
name: binaries
path: |
bin/
- name: Release
uses: softprops/action-gh-release@v1
if: startsWith(github.ref, 'refs/tags/')
with:
files: bin/
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1 @@
bin
bin
13 changes: 13 additions & 0 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# How to release a new version

- In the github.com ui [Release page](https://github.com/IBM/idemix/releases) click on _'Draft a new release'_
- Select _'Choose a tag'_ and enter a new tag of the format `v0.0.3` or whatever the next number should be
- note the action workflow later is expecting the tag to start with a 'v'
- this balances some degree of consistency but with flexability to create tags say `v1.0.0-beta-2`
- Please see the [Go notes on module versions](https://go.dev/doc/modules/version-numbers) for more information
- Enter a title - typically something like `Idemix v0.0.3` but no requirements
- The description is free-form - any information on noteable updates can be made. Also the _'generate release notes'_ button is very good at getting a basic changelog.
- Click _'Publish release'_

A new release is created, with a tag that can be used in `go get` commands
But also a github action is run to attache the idemix binaries to the release notes automatically.

0 comments on commit 4757feb

Please sign in to comment.