fix merge

zk-org · Nov 27, 2024 · c1130cf · c1130cf
2 parents 5e566a2 + 108a672
commit c1130cf
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 13 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -15,17 +15,25 @@ jobs:
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
+      - name: Update Homebrew Formula
+        uses: dawidd6/action-homebrew-bump-formula@v4
+        with:
+          token: ${{secrets.HOMEBREW_GITHUB_TOKEN}}
+          formula: zk
+      - name: Set vars
+        id: vars
+        run: echo "version=$(git describe --tags --match v[0-9]* 2> /dev/null)" >> $GITHUB_OUTPUT
       - name: Create GitHub Release
         uses: softprops/action-gh-release@v1
         with:
           files: |
-            zk-${{ needs.build-binaries.outputs.version }}-linux-amd64.tar.gz
-            zk-${{ needs.build-binaries.outputs.version }}-linux-i386.tar.gz
-            zk-${{ needs.build-binaries.outputs.version }}-linux-arm64.tar.gz
-            zk-${{ needs.build-binaries.outputs.version }}-alpine-amd64.tar.gz
-            zk-${{ needs.build-binaries.outputs.version }}-alpine-i386.tar.gz
-            zk-${{ needs.build-binaries.outputs.version }}-macos-x86_64.tar.gz
-            zk-${{ needs.build-binaries.outputs.version }}-macos_arm64.tar.gz
-            zk-${{ needs.build-binaries.outputs.version }}-windows_x64_86.tar.gz
+            zk-${{ needs.vars.outputs.version }}-linux-amd64.tar.gz
+            zk-${{ needs.vars.outputs.version }}-linux-i386.tar.gz
+            zk-${{ needs.vars.outputs.version }}-linux-arm64.tar.gz
+            zk-${{ needs.vars.outputs.version }}-alpine-amd64.tar.gz
+            zk-${{ needs.vars.outputs.version }}-alpine-i386.tar.gz
+            zk-${{ needs.vars.outputs.version }}-macos-x86_64.tar.gz
+            zk-${{ needs.vars.outputs.version }}-macos_arm64.tar.gz
+            zk-${{ needs.vars.outputs.version }}-windows_x64_86.tar.gz
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -72,11 +72,18 @@ When `zk` is ready to be released, you can update the `CHANGELOG.md`
 and create a new Git version tag (for example `v0.13.0`). Make sure you follow the
 [Semantic Versioning](https://semver.org) scheme.
 
-Then, create [a new GitHub release](https://github.com/zk-org/zk/releases) with a copy of
-the latest `CHANGELOG.md` entries and the binaries for all supported platforms.
-
-Binaries can be downloaded from the `build-binaries.yml` Actions run
-that was triggered by pushing the tag and uploaded to the release.
+If you create the git tag via the command line, and push it, then the
+[release action](.github/workflows/release.yml) will be triggered. This in turn
+calls the [build-binaries action](.github/workflows/build-binaries.yml), creates a
+release on GitHub and attaches the built binaries.
+
+Alternatively, you can manually create a release via the GitHub interface, also
+creating a release tag. Then you would run the [build-binaries
+action](.github/workflows/build-binaries.yml) manually, and download and
+attach the binaries manually.
+
+In both cases the description of the release can be edited after the release is
+created (i.e, adding or editing the changelog).
 
 ## Documentation