Automate release process (#42)

gradle · Aug 2, 2024 · 76330d2 · 76330d2
1 parent d0c4c24
commit 76330d2
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 8 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -1,11 +1,9 @@
-name: Create Release
+name: Publish Release
 
 on:
-  workflow_dispatch:
-    inputs:
-      release_version:
-        description: Release version.
-        required: true
+  push:
+    tags:
+      - 'v*'
 
 jobs:
   release:
@@ -20,5 +18,3 @@ jobs:
         uses: softprops/action-gh-release@v2
         with:
           body_path: release/changelog.md
-          name: ${{ github.event.inputs.release_version }}
-          tag_name: v${{ github.event.inputs.release_version }}
diff --git a/README.md b/README.md
@@ -283,4 +283,16 @@ The following permissions are required for this action to operate:
 
 ```bash
 npm run all
+```
+
+---
+
+## Release the action
+
+- Upgrade the release notes in `release/changelog.md`
+- Push the new version as a tag:
+
+```bash
+git tag vX.Y
+git push origin vX.Y
 ```