Merge pull request #708 from YDX-2147483647/ci

ci: Correct file paths and allow testing `release.yml`

Author: YDX-2147483647

.github/workflows/release.yml

@@ -4,6 +4,8 @@ on:
   release:
     types:
       - published
+  workflow_dispatch:
+    # Allow testing the release process without publishing a real release.
 
 jobs:
   build:
@@ -12,6 +14,10 @@ jobs:
 
     steps:
       - uses: actions/checkout@v6
+        with:
+          # Fetch more history for workflow_dispatch, required by `just update-version`.
+          fetch-depth: ${{ github.event_name == 'workflow_dispatch' && 100 || 1 }}
+          fetch-tags: ${{ github.event_name == 'workflow_dispatch' }}
       - uses: TeX-Live/setup-texlive-action@v3
         with:
           version: 2025
@@ -41,17 +47,17 @@ jobs:
           fc-cache
 
       - name: Update version if prerelease
-        if: ${{ github.event.release.prerelease }}
+        if: ${{ github.event_name == 'workflow_dispatch' || github.event.release.prerelease }}
         # 目前发布正式版时，会手动提升版本号
-        run: python scripts/update_version.py
+        run: just update-version
 
       - run: just doc handbooks
 
       - name: Upload bithesis.pdf for later usage.
         uses: actions/upload-artifact@v6
         with:
           name: bithesis
-          path: bithesis.pdf
+          path: src/bithesis.pdf
       - name: Upload handbooks for later usage.
         uses: actions/upload-artifact@v6
         with:
@@ -61,7 +67,7 @@ jobs:
         uses: actions/upload-artifact@v6
         with:
           name: cls
-          path: "*.cls"
+          path: "src/*.cls"
 
   publish_templates:
     name: Publish ${{ matrix.template }}
@@ -105,28 +111,31 @@ jobs:
         uses: actions/download-artifact@v7
         with:
           name: bithesis
+          path: src
       - name: Download `*.cls`
         uses: actions/download-artifact@v7
         with:
           name: cls
+          path: src
       - name: Copy manual to the template folder.
         run: |
-          mv bithesis.pdf ./templates/${{ matrix.template }}
+          mv src/bithesis.pdf ./templates/${{ matrix.template }}
           just copy-only
       - name: Install zip
         uses: montudor/action-zip@v1
       - name: Zip files under ./${{ matrix.template }}
         run: zip -qq -r ./${{ matrix.template }}.zip ./${{ matrix.template }}
         working-directory: ./templates
       - name: Upload ${{ matrix.template }}.zip to release
+        if: ${{ github.event_name == 'release' }}
         run: |
           gh release upload ${{ github.event.release.tag_name }} \
             "./templates/${{ matrix.template }}.zip#模板包·${{ matrix.label }} — ${{ matrix.template }}.zip"
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
   publish_cls:
-    name: Publish ${{ matrix.cls }}
+    name: Publish ${{ matrix.cls.name }}.cls
     runs-on: ubuntu-latest
     needs: build
 
@@ -146,17 +155,19 @@ jobs:
         uses: actions/download-artifact@v7
         with:
           name: cls
+          path: src
       - name: Upload ${{ matrix.cls.name }}.cls to release
+        if: ${{ github.event_name == 'release' }}
         run: |
           gh release upload ${{ github.event.release.tag_name }} \
-            "${{ matrix.cls.name }}.cls#文档类·${{ matrix.cls.label }} — ${{ matrix.cls.name }}.cls（用于升级替换）"
+            "src/${{ matrix.cls.name }}.cls#文档类·${{ matrix.cls.label }} — ${{ matrix.cls.name }}.cls（用于升级替换）"
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
   release_notes:
     name: Populate release notes with latest changelog and PDFs
     runs-on: ubuntu-latest
-    # Makesure it's the last job.
+    # Make sure it's the last job.
     needs: [build, publish_cls, publish_templates]
     outputs:
       release_body: ${{ steps.git-cliff.outputs.content }}
@@ -182,10 +193,12 @@ jobs:
         uses: actions/download-artifact@v7
         with:
           name: bithesis
+          path: src
       - name: Upload bithesis.pdf and changelog
         uses: svenstaro/upload-release-action@v2
+        if: ${{ github.event_name == 'release' }}
         with:
-          file: bithesis.pdf
+          file: src/bithesis.pdf
           repo_token: ${{ secrets.GITHUB_TOKEN }}
           tag: ${{ github.ref }}
           overwrite: true
@@ -205,6 +218,7 @@ jobs:
           name: handbooks
           path: handbook
       - name: Upload handbooks
+        if: ${{ github.event_name == 'release' }}
         run: |
           gh release upload ${{ github.event.release.tag_name }} \
             "handbook/undergraduate-handbook.pdf#快速使用指南·本科"
@@ -226,6 +240,7 @@ jobs:
         uses: actions/download-artifact@v7
         with:
           name: bithesis
+          path: src
       - name: Download handbooks
         uses: actions/download-artifact@v7
         with:
@@ -235,7 +250,7 @@ jobs:
       - uses: actions/upload-artifact@v6
         with:
           name: ctan-pkg
-          path: bithesis.zip
+          path: target/bithesis.zip
       - name: Determine version
         id: version
         run: |
@@ -244,10 +259,10 @@ jobs:
           echo "date=$(date '+%Y-%m-%d')" >> "$GITHUB_OUTPUT"
       - name: Upload to CTAN
         uses: paolobrasolin/ctan-submit-action@v1
-        if: ${{ ! github.event.release.prerelease }}
+        if: ${{ github.event_name == 'release' && ! github.event.release.prerelease }}
         with:
           action: upload
-          file_path: bithesis.zip
+          file_path: target/bithesis.zip
           fields: |
             update: "true"
             pkg: bithesis
@@ -256,7 +271,7 @@ jobs:
             email: bithesis@bitnp.net
             uploader: Feng Kaiyu
       - name: Report
-        if: ${{ ! github.event.release.prerelease }}
+        if: ${{ github.event_name == 'release' && ! github.event.release.prerelease }}
         run: >
           echo "🎉 Successfully upload
           ${{ steps.version.outputs.number }} (${{ steps.version.outputs.date }})
@@ -265,7 +280,7 @@ jobs:
   changelog:
     name: Update CHANGELOG
     runs-on: ubuntu-latest
-    if: ${{ ! github.event.release.prerelease }}
+    if: ${{ github.event_name == 'release' && ! github.event.release.prerelease }}
     steps:
       - name: Checkout
         uses: actions/checkout@v6

justfile

@@ -97,6 +97,11 @@ regression-test *ARGS: copy
 target-dir:
     @mkdir -p target
 
+# Update the version number for prereleases (mainly for CI)
+[group('release')]
+update-version SUFFIX="":
+    python scripts/update_version.py {{ SUFFIX }}
+
 # Build the ZIP for submission to CTAN (mainly for CI)
 [group('release')]
 pkg: doc handbooks pkg-only

scripts/update_version.py

@@ -70,7 +70,7 @@ def get_date() -> datetime:
 
 def update(human_version: str | None = None) -> None:
     """Update versions in `bithesis.dtx` with an optional `human_version` suffix."""
-    file = Path(__file__).parent.parent / "bithesis.dtx"
+    file = Path(__file__).parent.parent / "src/bithesis.dtx"
     doc = file.read_text(encoding="utf-8")
 
     version = get_version()