chore: streamline compatibility tracking and documentation

2026-10-09 11:43:02 +08:00
1 parent 92d2ba9889
commit 23f0456622
@@ -2,12 +2,11 @@ name: Gitea Version Tracker

 on:
  schedule:
-    # Daily at 08:00 UTC — check for new Gitea releases
    - cron: '0 8 * * *'
  workflow_dispatch:
    inputs:
      version:
-        description: 'Gitea version (e.g. 1.27.0) — leave empty to auto-detect'
+        description: 'Stable Gitea version (e.g. 28.2.0); empty means latest'
        required: false

 jobs:
@@ -20,103 +19,32 @@ jobs:
    steps:
      - uses: actions/checkout@v4

-      - name: Determine latest Gitea version
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Test tracker
+        run: python -B -m unittest discover -s .github/scripts -p 'test_*.py'
+
+      - name: Record pending Gitea release
        id: version
-        run: |
-          if [ -n "${{ github.event.inputs.version }}" ]; then
-            NEW_VERSION="${{ github.event.inputs.version }}"
-          else
-            # Fetch latest release from GitHub API (go-gitea/gitea mirror)
-            RELEASE_JSON=$(curl -sSf https://api.github.com/repos/go-gitea/gitea/releases/latest)
-            NEW_VERSION=$(echo "$RELEASE_JSON" | jq -r '.tag_name')
-          fi
-          # Strip 'v' prefix if present (API returns v1.27.0, we use 1.27.0)
-          NEW_VERSION="${NEW_VERSION#v}"
-          echo "New Gitea version: $NEW_VERSION"
-
-          # Parse marker line AND embedded OFFSET to locate the data row
-          MARKER_INFO=$(grep -n 'TRACKER:QUICK-REF-MAX' COMPATIBILITY.md)
-          MARKER_LINE=$(echo "$MARKER_INFO" | cut -d: -f1)
-          OFFSET=$(echo "$MARKER_INFO" | sed 's/.*OFFSET=\([0-9]*\).*/\1/')
-          CURRENT=$(sed -n "$((MARKER_LINE + OFFSET))p" COMPATIBILITY.md | awk -F'|' '{gsub(/\*| /, "", $4); print $4}')
-          echo "Current max tested: $CURRENT"
-
-          echo "new_version=$NEW_VERSION" >> $GITHUB_OUTPUT
-          echo "current_version=$CURRENT" >> $GITHUB_OUTPUT
-
-          if [ "$NEW_VERSION" = "$CURRENT" ]; then
-            echo "No new Gitea release detected. Skipping."
-            echo "skip=true" >> $GITHUB_OUTPUT
-          else
-            echo "New version detected: $CURRENT → $NEW_VERSION"
-            echo "skip=false" >> $GITHUB_OUTPUT
-          fi
-
-      - name: COMPATIBILITY.md — Quick Reference (max tested version)
-        if: steps.version.outputs.skip != 'true'
-        run: |
-          NEW="${{ steps.version.outputs.new_version }}"
-          # Parse marker line and embedded OFFSET to locate the data row
-          MARKER_INFO=$(grep -n 'TRACKER:QUICK-REF-MAX' COMPATIBILITY.md)
-          MARKER=$(echo "$MARKER_INFO" | cut -d: -f1)
-          OFFSET=$(echo "$MARKER_INFO" | sed 's/.*OFFSET=\([0-9]*\).*/\1/')
-          TARGET=$((MARKER + OFFSET))
-          # Update column 4 (Max Tested) and column 5 (Status) in the pipe-separated row
-          awk -i inplace -F'|' -v OFS='|' -v ver="${NEW}" '
-            NR == '$TARGET' { $4 = " **" ver "** "; $5 = " ⏳ Pending Verification " }
-            { print }
-          ' COMPATIBILITY.md
-
-      - name: COMPATIBILITY.md — Version History table
-        if: steps.version.outputs.skip != 'true'
-        run: |
-          NEW="${{ steps.version.outputs.new_version }}"
-          TODAY=$(date +%Y-%m-%d)
-          # Parse marker line and embedded OFFSET for the insertion point
-          MARKER_INFO=$(grep -n 'TRACKER:VERSION-INSERT' COMPATIBILITY.md)
-          MARKER=$(echo "$MARKER_INFO" | cut -d: -f1)
-          OFFSET=$(echo "$MARKER_INFO" | sed 's/.*OFFSET=\([0-9]*\).*/\1/')
-          INSERT=$((MARKER + OFFSET))
-          ROW="| **${NEW}** | ${TODAY} | ⏳ Pending Verification | TBD |"
-          sed -i "${INSERT}a ${ROW}" COMPATIBILITY.md
-
-      - name: README.md — pending badge
-        if: steps.version.outputs.skip != 'true'
-        run: |
-          NEW="${{ steps.version.outputs.new_version }}"
-          # Badge: update version, change label tested→pending, color blue→yellow
-          sed -i "/TRACKER:BADGE/s/%20[0-9a-z.-]*%20tested-blue/%20${NEW}%20pending-yellow/" README.md
+        run: python -B .github/scripts/track_gitea_release.py
+        env:
+          GITEA_VERSION: ${{ github.event.inputs.version }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      - name: Create Pull Request
-        if: steps.version.outputs.skip != 'true'
+        if: steps.version.outputs.changed == 'true'
        uses: peter-evans/create-pull-request@v7
        with:
-          branch: track/gitea-${{ steps.version.outputs.new_version }}
-          commit-message: "docs: track Gitea ${{ steps.version.outputs.new_version }} — pending verification"
-          title: "Track Gitea ${{ steps.version.outputs.new_version }} — ⏳ Pending Verification"
+          add-paths: '*.md'
+          branch: track/gitea-${{ steps.version.outputs.version }}
+          commit-message: "docs: track Gitea ${{ steps.version.outputs.version }} pending verification"
+          title: "Track Gitea ${{ steps.version.outputs.version }} compatibility"
          body: |
-            Gitea **${{ steps.version.outputs.new_version }}** has been released.
+            Gitea **${{ steps.version.outputs.version }}** is recorded as [PENDING] across the marked documentation. Verified/tested ranges remain unchanged.

-            This PR:
-            - Updates the compatibility matrix in `COMPATIBILITY.md`
-            - Marks the new version as pending in the `README.md` badge
-            - Marks the new version as **⏳ Pending Verification**
-
-            ## Verification Checklist
-            - [ ] Check [Gitea changelog](https://github.com/go-gitea/gitea/blob/main/CHANGELOG.md) for mail template changes
-            - [ ] Review diff of official templates: `git diff v${{ steps.version.outputs.current_version }}..v${{ steps.version.outputs.new_version }} -- templates/mail/ services/mailer/`
-            - [ ] Run `cd tools && go run . preview all` to confirm templates still render
-            - [ ] Run `cd tools && go test ./...` to verify push-notification data paths
-            - [ ] Update status from ⏳ to ✅ (compatible) or ❌ (breaking) in COMPATIBILITY.md
-            - [ ] Update the `Mail Template Changes` and `Breaking?` columns with accurate notes
-            - [ ] After verification, update `TRACKER:LATEST-VERIFIED` and the English/Chinese `TRACKER:LATEST-TESTED` lines; switch the README badge from pending to tested
-
-            ## Semantic tracking
-            Once verified, update the tracked Gitea version:
-            - [ ] If templates changed, mark the top **Template Release** row `Unreleased` until the fix is tagged; if no change is needed, retain the verified release tag
-            - [ ] Update the README release status and compatibility matrix to distinguish source fixes from published packages
-            - [ ] Write `.github/release-notes/vX.Y.Z.md` before tagging; the release workflow uses this file for the published notes
-            - [ ] Tag a new release when shipping template fixes — `git tag vX.Y.Z && git push origin vX.Y.Z` (the release workflow packages automatically)
-          labels: compatibility, automated
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+            - [ ] Review upstream mail templates, mailer data, functions, and translation keys.
+            - [ ] Run `cd tools && go test ./...` and `go run . preview all`.
+            - [ ] Record findings in `COMPATIBILITY.md`; update tested ranges and status text only after verification.
+            - [ ] If template changes are needed, release them separately with reviewed notes and assets.
@@ -34,16 +34,26 @@ jobs:
    steps:
      - uses: actions/checkout@v4

+      - uses: actions/setup-go@v5
+        with:
+          go-version: '1.21'
+
      - name: Verify release notes
        run: test -s ".github/release-notes/${GITHUB_REF_NAME}.md"

+      - name: Generate static preview for the archive
+        working-directory: tools
+        run: go run . preview all
+
      - name: Package themes/
        run: |
          VERSION=${GITHUB_REF#refs/tags/}
          ARCHIVE="gitea-mail-templates-${VERSION}"
-          mkdir -p "dist/${ARCHIVE}/docs"
+          mkdir -p "dist/${ARCHIVE}/docs" "dist/${ARCHIVE}/preview"
          cp -r themes LICENSE README.md CONTRIBUTING.md COMPATIBILITY.md "dist/${ARCHIVE}/"
          cp docs/README.zh-CN.md docs/CONTRIBUTING.zh-CN.md "dist/${ARCHIVE}/docs/"
+          cp -r docs/images "dist/${ARCHIVE}/docs/"
+          cp preview/index.html preview/rendered.js "dist/${ARCHIVE}/preview/"
          cd dist
          zip -r "${ARCHIVE}.zip" "${ARCHIVE}"
          tar -czf "${ARCHIVE}.tar.gz" "${ARCHIVE}"