Merge remote-tracking branch 'upstream/master' into dev

Bilb · Bilb · commit 3f9d057164ae · 2025-08-29T10:14:52.000+10:00
diff --git a/.github/workflows/build-binaries.yml b/.github/workflows/build-binaries.yml
@@ -21,7 +21,7 @@ on:
       target_branch:
         description: 'Branch to make a release of'
         required: true
-        default: 'dev'
+        default: 'master'
 
 # Dynamic name for the run
 run-name: >
@@ -31,21 +31,23 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
   cancel-in-progress: true
 
-env:
-  # we only want to publish on "push to master" or alpha releases. When we don't want to publish, we want to upload artefacts
-  SHOULD_PUBLISH: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
-  SHOULD_PUBLISH_ALPHA: ${{ github.event_name == 'push' && startsWith(github.ref, 'refs/heads/release') && contains(github.ref, '-alpha.') }}
-
 jobs:
   create_draft_release_if_needed:
     runs-on: ubuntu-latest
     env:
       GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      # we only want to publish on "push to master" or alpha releases. When we don't want to publish, we want to upload artefacts
+      SHOULD_PUBLISH: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
+      SHOULD_PUBLISH_ALPHA: ${{ github.event_name == 'push' && startsWith(github.ref, 'refs/heads/release') && contains(github.ref, '-alpha.') }}
+
     outputs:
+      # Note: It is very important to only set this when we want to do a release,
+      # as this will be used in the others jobs to know if we need to make a release/upload artefacts
       version_tag: ${{ steps.get_version.outputs.VERSION_TAG }}
     steps:
       - name: Checkout git repo
         uses: actions/checkout@v4
+        if: ${{ env.SHOULD_PUBLISH == 'true' || env.SHOULD_PUBLISH_ALPHA == 'true' }}
         # We only need a few files in this run, no point cloning everything
         with:
           sparse-checkout: |
@@ -56,6 +58,8 @@ jobs:
           ref: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.target_branch || github.ref  }}
 
       - name: Get version tag from package.json
+        # Make sure to skip this step if we do not want to make a release, as the other jobs will otherwise create a release.
+        if: ${{ env.SHOULD_PUBLISH == 'true' || env.SHOULD_PUBLISH_ALPHA == 'true' }}
         id: get_version
         run: |
           version=$(node -p "require('./package.json').version")
@@ -68,14 +72,14 @@ jobs:
         with:
           tag: v${{ steps.get_version.outputs.VERSION_TAG }}
           name: 'Session ${{ steps.get_version.outputs.VERSION_TAG }}'
-          draft: true
+          draft: true # important to keep this, so we **NEVER** make a live release through the CI
           bodyFile: ${{ env.SHOULD_PUBLISH_ALPHA == 'true' && 'build/release-notes-alpha.md' || 'build/release-notes.md' }}
           allowUpdates: true
+          # updateOnlyUnreleased: true Not needed as we already have `skipIfReleaseExists`
           skipIfReleaseExists: true
+          makeLatest: false
           omitBodyDuringUpdate: true
-          omitDraftDuringUpdate: true
           omitNameDuringUpdate: true
-          omitPrereleaseDuringUpdate: true
 
   build_linux:
     runs-on: ubuntu-22.04
@@ -113,21 +117,20 @@ jobs:
         run: yarn test
 
       - name: Make release build but do not publish ${{ matrix.pkg_to_build }}
-        # always run this, except on "push" to "master" or alpha releases
-        if: ${{ env.SHOULD_PUBLISH == 'false' && env.SHOULD_PUBLISH_ALPHA == 'false'  }}
+        # we do want this part to run only when version_tag is unset (i.e. we are not making a release)
+        if: ${{ needs.create_draft_release_if_needed.outputs.version_tag == ''  }}
         run: |
           sed -i 's/"target": "deb"/"target": "${{ matrix.pkg_to_build }}"/g' package.json && yarn build-release
 
       - name: Upload artefacts ${{ matrix.pkg_to_build }}
-        # always run this, except on "push" to "master" or alpha releases
-        if: ${{ env.SHOULD_PUBLISH == 'false' && env.SHOULD_PUBLISH_ALPHA == 'false'  }}
+        # we do want this part to run only when version_tag is unset (i.e. we are not making a release)
+        if: ${{ needs.create_draft_release_if_needed.outputs.version_tag == ''  }}
         uses: ./actions/upload_prod_artefacts
         with:
           upload_prefix: ${{ runner.os }}-${{ runner.arch }}-${{ matrix.pkg_to_build }}
 
       - name: Make release build & publish ${{ matrix.pkg_to_build }}
-        # only run this on "push" to "master" or alpha releases
-        if: ${{ env.SHOULD_PUBLISH == 'true' || env.SHOULD_PUBLISH_ALPHA == 'true' }}
+        if: ${{ needs.create_draft_release_if_needed.outputs.version_tag != '' }}
         run: |
           sed -i 's/"target": "deb"/"target": "${{ matrix.pkg_to_build }}"/g' package.json && yarn build-release-publish
 
@@ -136,14 +139,14 @@ jobs:
         # Note: The jobs are overwriting each other's latest-linux.yml.
         # So, we upload all of them as artifacts, and then merge them (see `post_build_linux`)
         # note: freebsd does not generate a latest-linux.yml file so we exclude it
-        if: ${{ (env.SHOULD_PUBLISH == 'true' || env.SHOULD_PUBLISH_ALPHA == 'true') && matrix.pkg_to_build != 'freebsd' }}
+        if: ${{ needs.create_draft_release_if_needed.outputs.version_tag != '' && matrix.pkg_to_build != 'freebsd' }}
         shell: bash
         run: |
           mv dist/latest-linux.yml dist/latest-linux-${{ matrix.pkg_to_build }}-${{ github.sha }}.yml
 
       - name: Upload release metadata
         # only run this on "push" to "master" or alpha releases
-        if: ${{ (env.SHOULD_PUBLISH == 'true' || env.SHOULD_PUBLISH_ALPHA == 'true') && matrix.pkg_to_build != 'freebsd' }}
+        if: ${{ needs.create_draft_release_if_needed.outputs.version_tag != '' && matrix.pkg_to_build != 'freebsd' }}
         uses: actions/upload-artifact@v4
         with:
           name: latest-linux-${{ matrix.pkg_to_build }}-${{ github.sha }}.yml
@@ -152,12 +155,11 @@ jobs:
   post_build_linux:
     needs: [create_draft_release_if_needed, build_linux]
     runs-on: ubuntu-22.04
+    if: ${{ needs.create_draft_release_if_needed.outputs.version_tag != '' }}
     env:
       GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     steps:
       - name: Checkout git repo
-        # only run this on "push" to "master" or alpha releases
-        if: ${{ env.SHOULD_PUBLISH == 'true' || env.SHOULD_PUBLISH_ALPHA == 'true' }}
         uses: actions/checkout@v4
         # We only need a few files in this run, no point cloning everything
         with:
@@ -168,32 +170,29 @@ jobs:
           ref: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.target_branch || github.ref  }}
 
       - name: Download release metadata
-        # only run this on "push" to "master" or alpha releases
-        if: ${{ env.SHOULD_PUBLISH == 'true' || env.SHOULD_PUBLISH_ALPHA == 'true' }}
         uses: actions/download-artifact@v4
         with:
           pattern: latest-linux-*-${{ github.sha }}.yml
           path: dist
           merge-multiple: true
 
       - name: Combine release metadata
-        # only run this on "push" to "master" or alpha releases
-        if: ${{ env.SHOULD_PUBLISH == 'true' || env.SHOULD_PUBLISH_ALPHA == 'true' }}
         run: |
           ./build/setup-release-combine.sh ${{ github.sha }} linux
 
       - name: Upload changes to draft release
-        # only run this on "push" to "master" or alpha releases
-        if: ${{ env.SHOULD_PUBLISH == 'true' || env.SHOULD_PUBLISH_ALPHA == 'true' }}
         uses: ncipollo/release-action@v1
         with:
+          # the if at the job level checks that version_tag is not empty
           tag: v${{ needs.create_draft_release_if_needed.outputs.version_tag }}
           artifacts: 'dist/latest-linux.yml'
+          draft: true # important to keep this, so we **NEVER** make a live release through the CI
           allowUpdates: true
           omitNameDuringUpdate: true
           omitBodyDuringUpdate: true
           replacesArtifacts: true
           updateOnlyUnreleased: true
+          makeLatest: false
 
   build_windows:
     runs-on: windows-2022
@@ -219,19 +218,18 @@ jobs:
 
       - name: Make release build but do not publish
         # always run this, except on "push" to "master" or alpha releases
-        if: ${{ env.SHOULD_PUBLISH == 'false' && env.SHOULD_PUBLISH_ALPHA == 'false'  }}
+        if: ${{ needs.create_draft_release_if_needed.outputs.version_tag == ''  }}
         run: yarn build-release
 
       - name: Upload artefacts
-        # always run this, except on "push" to "master" or alpha releases
-        if: ${{ env.SHOULD_PUBLISH == 'false' && env.SHOULD_PUBLISH_ALPHA == 'false'  }}
+        # we do want this part to run only when version_tag is unset (i.e. we are not making a release)
+        if: ${{ needs.create_draft_release_if_needed.outputs.version_tag == ''  }}
         uses: ./actions/upload_prod_artefacts
         with:
           upload_prefix: ${{ runner.os }}-${{ runner.arch }}
 
       - name: Make release build & publish
-        # only run this on "push" to "master" or alpha releases
-        if: ${{ env.SHOULD_PUBLISH == 'true' || env.SHOULD_PUBLISH_ALPHA == 'true' }}
+        if: ${{ needs.create_draft_release_if_needed.outputs.version_tag != '' }}
         run: yarn build-release-publish # No other args needed for windows publish
 
   # We want both arm64 and intel mac builds, and according to this https://docs.github.com/en/actions/using-github-hosted-runners/using-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources macos-14 and above is always arm64 and macos-13 is the last intel runner
@@ -267,7 +265,7 @@ jobs:
         uses: ./actions/make_release_build
         with:
           architecture: arm64
-          should_publish: ${{ env.SHOULD_PUBLISH == 'true' || env.SHOULD_PUBLISH_ALPHA == 'true' }}
+          should_publish: ${{ needs.create_draft_release_if_needed.outputs.version_tag != ''}}
 
   build_mac_x64:
     runs-on: macos-13
@@ -300,17 +298,16 @@ jobs:
         uses: ./actions/make_release_build
         with:
           architecture: x64
-          should_publish: ${{ env.SHOULD_PUBLISH == 'true' || env.SHOULD_PUBLISH_ALPHA == 'true' }}
+          should_publish: ${{ needs.create_draft_release_if_needed.outputs.version_tag != '' }}
 
   post_build_mac:
     needs: [create_draft_release_if_needed, build_mac_arm64, build_mac_x64]
     runs-on: ubuntu-22.04
+    if: ${{ needs.create_draft_release_if_needed.outputs.version_tag != '' }}
     env:
       GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     steps:
       - name: Checkout git repo
-        # only run this on "push" to "master" or alpha releases
-        if: ${{ env.SHOULD_PUBLISH == 'true' || env.SHOULD_PUBLISH_ALPHA == 'true' }}
         uses: actions/checkout@v4
         # We only need a few files in this run, no point cloning everything
         with:
@@ -321,29 +318,26 @@ jobs:
           ref: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.target_branch || github.ref  }}
 
       - name: Download release metadata
-        # only run this on "push" to "master" or alpha releases
-        if: ${{ env.SHOULD_PUBLISH == 'true' || env.SHOULD_PUBLISH_ALPHA == 'true' }}
         uses: actions/download-artifact@v4
         with:
           pattern: latest-mac-*-${{ github.sha }}.yml
           path: dist
           merge-multiple: true
 
       - name: Combine release metadata
-        # only run this on "push" to "master" or alpha releases
-        if: ${{ env.SHOULD_PUBLISH == 'true' || env.SHOULD_PUBLISH_ALPHA == 'true' }}
         run: |
           ./build/setup-release-combine.sh ${{ github.sha }} mac
 
       - name: Upload changes to draft release
-        # only run this on "push" to "master" or alpha releases
-        if: ${{ env.SHOULD_PUBLISH == 'true' || env.SHOULD_PUBLISH_ALPHA == 'true' }}
         uses: ncipollo/release-action@v1
+        # the if at the job level checks that version_tag is not empty
         with:
           tag: v${{ needs.create_draft_release_if_needed.outputs.version_tag }}
           artifacts: 'dist/latest-mac.yml'
+          draft: true # important to keep this, so we **NEVER** make a live release through the CI
           allowUpdates: true
           omitNameDuringUpdate: true
           omitBodyDuringUpdate: true
           replacesArtifacts: true
           updateOnlyUnreleased: true
+          makeLatest: false
