Merge pull request #137 from NearNodeFlash/add-release-action

Auto-release when a tag is pushed

Author: ajfloeder

.github/workflows/publish-main.yaml

@@ -1,8 +1,6 @@
 name: Publish `main` Documentation
-on:
-  push:
-    branches:
-      - main
+
+on: [push]
 
 jobs:
   build:
@@ -34,3 +32,23 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
           mike deploy --push dev
+
+  create_release:
+    needs: build
+    if: startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+      with:
+        fetch-tags: true
+        fetch-depth: 0
+    - name: Repair tag
+      run: git fetch -f origin ${{ github.ref }}:${{ github.ref }}
+    - name: Verify that the tag is annotated
+      run: if test x$(git for-each-ref ${{ github.ref }} | awk '{print $2}') = xtag; then /bin/true; else echo "\"${{ github.ref }}\" does not look like an annotated tag!"; /bin/false; fi
+    - name: Release
+      uses: softprops/action-gh-release@v1
+      with:
+        #prerelease: true
+        generate_release_notes: true

docs/repo-guides/release-nnf-sw/readme.md

@@ -183,6 +183,7 @@ that everything is current on `master` for `nnf-deploy`.
 
 12. Follow steps 6-7 from the previous section to finalize the release of `nnf-deploy`.
 
+**Please review documenation for changes you may have made**
 **The software is now released!**
 
 ## Clone a release