github/workflows: auto generate changelog (#677)

Auto-generates changelog in github action. Also simplify by removing usage of docker image and just use local code.

category: misc
ticket: #320

.github/workflows/release.yml

@@ -8,31 +8,11 @@ jobs:
     runs-on: ubuntu-latest
     name: Publish Release
     steps:
-
-    # Wait for docker build to complete since we need pegged cli-reference.
-    - uses: fountainhead/[email protected]
-      with:
-        token: ${{ secrets.GITHUB_TOKEN }}
-        checkName: Build Docker Image
-
     - uses: actions/checkout@v2
-
-    - id: get-tag
-      run: |
-        tag=$(echo "${{ github.ref }}" | cut -d / -f 3)
-        echo "::set-output name=tag::$tag"
-
-    - run: docker run ghcr.io/obolnetwork/charon:${{steps.get-tag.outputs.tag}} run --help > cli-reference.txt
-
-    - run: cat cli-reference.txt
-
+    - run: go run . --help > cli-reference.txt
+    - run: go run testutil/genchangelog/main.go
     - uses: softprops/action-gh-release@v1
       with:
         files: cli-reference.txt
-        body: |
-          ![Obol Logo](https://obol.tech/obolnetwork.png)
-
-          Charon client version `${{steps.get-tag.outputs.tag}}`.
-
-          ###### This software is in beta, use with caution
+        body_path: changelog.md
         token: ${{ secrets.RELEASE_SECRET }}

docs/branching.md

@@ -29,10 +29,9 @@ We follow [Trunk Based Development](https://trunkbaseddevelopment.com/) as a bra
 
 Charon is set up to create a release with Github Actions triggered by a tag. To create a new release:
 
-1. Ensure all tests are passing
-1. Do a quick smoke test by running charon-docker-compose
-1. Identify the version of the release, e.g. `v0.1.2` (note the `v`).
-1. Push a PR that bumps charon version global variable, see example https://github.com/ObolNetwork/charon/pull/312
-1. Merge above PR, checkout latest main, and tag it: `git tag <version> && git push --tags`
-1. Generate changelog: `go run testutil/genchangelog/main.go`.
-1. Edit the auto-generated release on github: `https://github.com/ObolNetwork/charon/releases/tag/<version>`
+1. Ensure the build is green and that all tests are passing
+2. Identify the version of the release, e.g. `v0.1.2` (note the `v`).
+3. Push a PR that bumps charon version global variable, see example https://github.com/ObolNetwork/charon/pull/312
+4. Merge above PR, checkout latest main, and tag it: `git tag <version> && git push --tags`
+5. Double-check the generated release and changelog: `https://github.com/ObolNetwork/charon/releases/tag/<version>`
+6. Maybe generate a changelog manually and/or update the release: `go run testutil/genchangelog/main.go`