One-step release action

.github/workflows/build_sdist.yml

@@ -0,0 +1,96 @@
+name: Build and test sdist
+
+on:
+  workflow_dispatch:
+    inputs:
+      ref:
+        description: "Target branch / tag / commit"
+        required: true
+        type: string
+  workflow_call:
+    inputs:
+      ref:
+        description: "Target branch / tag / commit"
+        required: true
+        type: string
+
+jobs:
+  build-sdist:
+    name: Build sdist
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.ref }}
+          fetch-depth: 0
+          fetch-tags: true
+
+      - name: Create source distribution
+        shell: bash -l {0}
+        run: |
+          pipx run build --sdist .
+
+      - name: Upload source dist as build artifact
+        uses: actions/upload-artifact@v4
+        with:
+            name: python-source-distribution
+            path: dist/
+            if-no-files-found: error
+
+  test-sdist:
+    needs: build-sdist
+    name: Test build from sdist on Windows
+    runs-on: windows-latest
+    steps:
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+
+      - name: Find MSVC and set environment variables
+        shell: bash -l {0}
+        env:
+          MSVC_PREFIX: 'C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC\Tools\MSVC'
+        run: |
+          echo "Available MSVC installations:"
+          ls "$MSVC_PREFIX"
+
+          MSVC_BIN=$(ls "$MSVC_PREFIX" | tail -n 1)\\bin\\HostX64\\x64
+          CC="$MSVC_PREFIX\\$MSVC_BIN\\cl.exe"
+          echo "CC: $CC"
+          echo "CC=$CC" >> $GITHUB_ENV
+
+          CC_LD="$MSVC_PREFIX\\$MSVC_BIN\\link.exe"
+          echo "CC_LD: $CC_LD"
+          echo "CC_LD=$CC_LD" >> $GITHUB_ENV
+
+      - name: Download sdist
+        uses: actions/download-artifact@v4
+        with:
+          path: dist/
+          merge-multiple: true
+
+      - name: List downloaded sdist
+        run: |
+          ls -R dist/
+
+      - name: Update pip
+        shell: bash -l {0}
+        run: |
+          python -m pip install --upgrade pip
+
+      - name: Install from sdist
+        shell: bash -l {0}
+        run: python -m pip install $(find dist -name 'euphonic-*.tar.gz')[matplotlib,phonopy-reader,brille,test]
+
+      - name: Checkout repository (for tests and test data)
+        uses: actions/checkout@v4
+
+      - name: Delete source (to ensure we are testing INSTALLED version)
+        shell: bash -l {0}
+        run: rm -rf euphonic
+
+      - name: run tests
+        shell: bash -l {0}
+        run: python tests_and_analysis/test/run_tests.py --report

.github/workflows/build_upload_pypi_wheels.yml → .github/workflows/build_wheels.yml

@@ -1,9 +1,18 @@
-name: Build and upload PyPI wheels and source dist
+name: Build and test Python wheels
 
 on:
-  release:
-    types: [published]
   workflow_dispatch:
+    inputs:
+      ref:
+        description: "Target branch / tag / commit"
+        required: true
+        type: string
+  workflow_call:
+    inputs:
+      ref:
+        description: "Target branch / tag / commit"
+        required: true
+        type: string
 
 jobs:
   build-wheels:
@@ -36,6 +45,7 @@ jobs:
       - name: Checkout project
         uses: actions/checkout@v4
         with:
+          ref: ${{ inputs.ref }}
           fetch-depth: 0
           fetch-tags: true
 
@@ -101,111 +111,3 @@ jobs:
             name: wheel-${{ matrix.wheelname }}-${{ matrix.python-version }}-${{ matrix.cibw_archs }}
             path: wheelhouse/*-${{ matrix.wheelname }}*_${{ matrix.cibw_archs }}.whl
             if-no-files-found: error
-
-  build-sdist:
-    name: Build sdist
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-          fetch-tags: true
-
-
-      - name: Create source distribution
-        shell: bash -l {0}
-        run: |
-          pipx run build --sdist .
-
-      - name: Upload source dist as build artifact
-        uses: actions/upload-artifact@v4
-        with:
-            name: python-source-distribution
-            path: dist/
-            if-no-files-found: error
-
-  test-sdist:
-    needs: build-sdist
-    name: Test build from sdist on Windows
-    runs-on: windows-latest
-    steps:
-      - name: Setup Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: 3.11
-
-      - name: Find MSVC and set environment variables
-        shell: bash -l {0}
-        env:
-          MSVC_PREFIX: 'C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC\Tools\MSVC'
-        run: |
-          echo "Available MSVC installations:"
-          ls "$MSVC_PREFIX"
-
-          MSVC_BIN=$(ls "$MSVC_PREFIX" | tail -n 1)\\bin\\HostX64\\x64
-          CC="$MSVC_PREFIX\\$MSVC_BIN\\cl.exe"
-          echo "CC: $CC"
-          echo "CC=$CC" >> $GITHUB_ENV
-
-          CC_LD="$MSVC_PREFIX\\$MSVC_BIN\\link.exe"
-          echo "CC_LD: $CC_LD"
-          echo "CC_LD=$CC_LD" >> $GITHUB_ENV
-
-      - name: Download sdist
-        uses: actions/download-artifact@v4
-        with:
-          path: dist/
-          merge-multiple: true
-
-      - name: List downloaded sdist
-        run: |
-          ls -R dist/
-
-      - name: Update pip
-        shell: bash -l {0}
-        run: |
-          python -m pip install --upgrade pip
-
-      - name: Install from sdist
-        shell: bash -l {0}
-        run: python -m pip install $(find dist -name 'euphonic-*.tar.gz')[matplotlib,phonopy-reader,brille,test]
-
-      - name: Checkout repository (for tests and test data)
-        uses: actions/checkout@v4
-
-      - name: Delete source (to ensure we are testing INSTALLED version)
-        shell: bash -l {0}
-        run: rm -rf euphonic
-
-      - name: run tests
-        shell: bash -l {0}
-        run: python tests_and_analysis/test/run_tests.py --report
-
-  publish:
-    if: github.event_name == 'release'
-    needs: [build-wheels,test-sdist]
-    name: Upload release to PyPI
-    runs-on: ubuntu-latest
-    environment:
-      name: pypi
-      url: https://pypi.org/p/euphonic
-    permissions:
-      id-token: write
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0  # This is possibly unnecessary?
-
-      - name: Download artifacts to Ubuntu environment
-        uses: actions/download-artifact@v4
-        with:
-          path: dist/
-          merge-multiple: true
-
-      - name: List Files
-        run: ls -R dist/
-
-      - name: Upload wheels to PyPI
-        uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/create-landing-page.yml

@@ -5,8 +5,14 @@ on:
       - master
     paths:
       - 'CITATION.cff'
-  release:
-    types: [published]
+
+  workflow_call:
+    inputs:
+      ref:
+        description: "Target: 'latest' or tag"
+        required: true
+        type: string
+        default: latest
 
 jobs:
   update-landing-page:
@@ -26,9 +32,9 @@ jobs:
       - name: Set env var based on (master) push trigger
         if: github.event_name == 'push'
         run: echo "PAGE_TYPE=latest" >> $GITHUB_ENV
-      - name: Set env var based on release
-        if: github.event_name == 'release'
-        run: echo "PAGE_TYPE=${{ github.event.release.name }}" >> $GITHUB_ENV
+      - name: Set env var based on workflow call
+        if: (github.event_name == 'workflow_call') || (github.event_name == 'workflow_dispatch')
+        run: echo "PAGE_TYPE=${{ inputs.ref }}" >> $GITHUB_ENV
       - name: Create landing page
         run: python write_doi_landing_page.py ${{ env.PAGE_TYPE }}
       - uses: EndBug/add-and-commit@v9

.github/workflows/release.yml

@@ -12,4 +12,96 @@ on:
         required: true
         type: string
       push:
-        description: "Push commit, tag and release"
+        description: "Make release and push to PyPI"
+        required: true
+        type: boolean
+        default: false
+
+jobs:
+  prepare:
+    name: Bump version number
+    uses: ./.github/workflows/set_version.yml
+    with:
+      ref: ${{ inputs.ref }}
+      version: ${{ inputs.version }}
+      push: true
+
+  build-sdist:
+    needs: prepare
+    name: Build and test sdist
+    uses: ./.github/workflows/build_sdist.yml
+    with:
+      ref: ${{ inputs.ref }}
+
+  build-wheels:
+    name: Build and test wheels
+    needs: prepare
+
+    uses: ./.github/workflows/build_wheels.yml
+    with:
+      ref: ${{ inputs.ref }}
+
+  release:
+    name: Github release
+    needs: [build-wheels,build-sdist]
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.ref }}
+          fetch-depth: 1
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Basic installation to check euphonic.__version__
+        shell: bash -l {0}
+        run: |
+          python -m pip install requests pyyaml
+          python -m pip install .
+
+      - name: Check version consistency, generate Github release page
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run : |
+          python build_utils/release.py --github ${{ inputs.push && '--notest' || '' }}
+
+  publish:
+    if: ${{ inputs.push }}
+    needs: release
+    name: Upload release to PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/euphonic
+    permissions:
+      id-token: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.ref }}
+          fetch-depth: 0  # This is possibly unnecessary?
+
+      - name: Download artifacts to Ubuntu environment
+        uses: actions/download-artifact@v4
+        with:
+          path: dist/
+          merge-multiple: true
+
+      - name: List Files
+        run: ls -R dist/
+
+      - name: Upload wheels to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  landing_page:
+    needs: [prepare,release]
+    if: ${{ inputs.push }}
+    name: Create landing page
+    uses: ./.github/workflows/create-landing-page.yml
+    with:
+      ref: ${{ needs.prepare.outputs.tag }}