Release process follow ups

.github/workflows/Documenter.yml

@@ -4,7 +4,9 @@ on:
   push:
     branches:
       - main
-    tags: ["*"]  # Triggers from tags ignore the `paths` filter: https://github.com/orgs/community/discussions/26273
+    release:
+      types:
+        - released
     paths:
       - "docs/**"
       - ".github/workflows/Documenter.yml"
@@ -21,6 +23,7 @@ env:
   build_dir: ./build
 jobs:
   docs:
+    if: github.event_name == 'release' && github.event.action == 'published'
     name: Build
     runs-on: ubuntu-latest
     permissions:

.github/workflows/Pre_release.yml

@@ -1,6 +1,13 @@
-name: "Publish Pre-Release"
+name: Publish Pre-Release
 on:
   workflow_dispatch:
+    inputs:
+      commit:  
+        # Note: The tag itself will not be based off this commit. As we must first commit the 
+        # updates to the Artifacts.toml, then the tag will be based off that commit.
+        description: The commit to branch from when making the tag
+        required: true
+
 # Force a single workflow to run at a time. This ensures we don't accidentally
 # try to perform concurrent publishing of releases.
 concurrency: publish-release
@@ -10,31 +17,25 @@ env:
   tarballs_dir: ./build/tarballs
 jobs:
   release:
-    name: "Publish Pre-Release"
+    name: Publish Pre-Release
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
     steps:
       - uses: actions/checkout@v4
         with:
-          fetch-depth: 0  # Needed determine latest tag
+          fetch-depth: 0  # Needed determine tags
           persist-credentials: true
-          ref: main
-      - name: Get Latest Tag
-        id: latest_tag
-        uses: WyriHaximus/github-action-get-previous-tag@v1
-        # TODO: in future we might need to perform backports, at which point we'll need to check
-        # that the project.version has not already been tagged 
-      - name: Check for updated Project version
+          ref: ${{ inputs.commit }}
+      - name: Check for new Project version
         id: project_toml
         shell: julia --color=yes --project {0}
-        env:
-          LATEST_TAG: ${{ steps.latest_tag.outputs.tag }}
         run: |
           using Pkg.Types
           project = read_project("Project.toml")
-          latest_tag = parse(VersionNumber, ENV["LATEST_TAG"])
+          tags = parse.(VersionNumber, split(readchomp(`git tag -l`), "\n"))
           @info "Project version: project.version"
-          @info "Latest tag: latest_tag"
-          project.version > latest_tag || exit(1)  # error if can't make a tag
+          project.version in tags && error("Tag v$(project.version) already exists")
           open(ENV["GITHUB_OUTPUT"], "a") do io
               println(io, "version=$(project.version)")
               println(io, "tag=v$(project.version)")
@@ -43,7 +44,7 @@ jobs:
         id: download-artifact
         uses: dawidd6/action-download-artifact@v2
         with:
-          commit: ${{ github.sha }}  # pull the artifacts for the last commit on main
+          commit: ${{ inputs.commit }}  # pull the artifacts for the given commit
           name: ray_julia_libraries
           path: ${{ env.tarballs_dir }}
           workflow: CI.yml
@@ -79,11 +80,13 @@ jobs:
           tag=${{ steps.project_toml.outputs.tag }}
           git tag $tag ${{ steps.commit.outputs.sha }}
           git push origin $tag
+      - name: Build Changelog
+        id: build_changelog
+        uses: mikepenz/release-changelog-builder-action@v4
       - name: Publish Pre-Release
-        uses: softprops/action-gh-release@v1
+        uses: ncipollo/release-action@v1
         with:
           prerelease: true
-          tag_name: ${{ steps.project_toml.outputs.tag }}
-          target_commitish: ${{ steps.commit.outputs.sha }}
-          generate_release_notes: true
-          files: ${{ env.tarballs_dir }}/*.tar.gz
+          tag: ${{ steps.project_toml.outputs.tag }}
+          artifacts: ${{ env.tarballs_dir }}/*.tar.gz
+          body: ${{ steps.build_changelog.outputs.changelog }}

.github/workflows/artifacts_CI.yml → .github/workflows/Release.yml

@@ -1,4 +1,4 @@
-name: Artifacts CI
+name: Publish Release
 on:
   workflow_dispatch:
   push:
@@ -62,13 +62,16 @@ jobs:
           with:
             annotate: true
   release:
-    name: "Publish Release"
+    name: Publish Release
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
     needs: [test]
     steps:
-      - name: Publish Release
-        uses: softprops/action-gh-release@v1
+      - name: Publish Pre-Release
+        uses: ncipollo/release-action@v1
         with:
-          # Any info keys (i.e. prerelease) that are not explicitly set will retain the original
-          # value if there is already an existing release for the tag.
+          allowUpdates: true
+          updateOnlyUnreleased: true
           prerelease: false
+          makeLatest: "legacy"

Project.toml

@@ -1,7 +1,7 @@
 name = "Ray"
 uuid = "3f779ece-f0b6-4c4f-a81a-0cb2add9eb95"
 authors = ["Beacon Biosignals, Inc"]
-version = "0.0.3"
+version = "0.0.4-dev"
 
 [deps]
 ArgParse = "c7e460c6-2fb9-53a9-8c5b-16f535851c63"

docs/src/building-artifacts.md

@@ -20,5 +20,4 @@ Once the PR has been merged into `main` and the CI has passed you must trigger t
 2. Generate the `Artifacts.toml` bindings and commit them.
 3. Create a new tag and GitHub pre-release which includes the artifacts as assets.
 
-The creation of the tag will trigger the "Artifacts CI" workflow which is responsible for verifying the generated artifacts work. 
-It will then promote the GitHub pre-release to a full release once those checks pass.
+Then you must trigger the ["Release" GitHub Action](https://github.com/beacon-biosignals/Ray.jl/actions/workflows/Release.yml) workflow which is responsible for verifying the generated artifacts work and promoting the aforementioned pre-release to a full release, setting it to "latest" if necessary.