Adopt rust-samp's release notes pipeline

NullSablex · NullSablex · commit 9b11aaeb192f · 2026-05-25T23:30:14.000-03:00
- Add .github/release-drafter.yml and .github/workflows/release-drafter.yml
  so a draft release stays auto-updated as PRs are merged, categorised by
  label, with the version resolved from feat/fix/breaking labels.
- Rewrite .github/workflows/release.yml: trigger on `v*` tag push and build
  the release body in three layers — the matching ## [X.Y.Z] section from
  CHANGELOG.md, the `## New Contributors` / `**Full Changelog**` appendix
  borrowed from the GitHub generate-notes API, and an Artifacts footer that
  lists .so/.dll/.inc with a pointer to docs/installation.md. The hardcoded
  SA-MP / open.mp install snippet is gone so the workflow can't drift from
  the docs.
- Strip the `---` separators between version sections in CHANGELOG.md; the
  `## [X.Y.Z]` headings are enough and the separators were leaking into the
  awk-extracted release body.
- Drop RELEASE.md — release notes are now assembled by the workflow from
  the CHANGELOG, so a separate file is just a drift hazard.
- Drop the root CNAME, keeping only docs/CNAME (the one MkDocs deploys).
diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml
@@ -0,0 +1,51 @@
+name-template: 'v$RESOLVED_VERSION'
+tag-template: 'v$RESOLVED_VERSION'
+
+categories:
+  - title: 'New features'
+    labels:
+      - 'feat'
+      - 'feature'
+  - title: 'Fixes'
+    labels:
+      - 'fix'
+      - 'bugfix'
+      - 'bug'
+  - title: 'Documentation'
+    labels:
+      - 'docs'
+      - 'documentation'
+  - title: 'Maintenance'
+    labels:
+      - 'chore'
+      - 'ci'
+      - 'refactor'
+      - 'deps'
+
+change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
+change-title-escapes: '\<*_&'
+
+version-resolver:
+  major:
+    labels:
+      - 'major'
+      - 'breaking'
+  minor:
+    labels:
+      - 'minor'
+      - 'feat'
+      - 'feature'
+  patch:
+    labels:
+      - 'patch'
+      - 'fix'
+      - 'bugfix'
+      - 'docs'
+      - 'chore'
+      - 'ci'
+  default: patch
+
+template: |
+  $CHANGES
+
+  Thanks to everyone who contributed: $CONTRIBUTORS
diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml
@@ -0,0 +1,16 @@
+name: Release Drafter
+
+on:
+  pull_request:
+    types: [opened, reopened, synchronize, labeled]
+
+jobs:
+  update-release-draft:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write      # create/update release draft
+      pull-requests: read  # read PR titles and labels to generate the notes
+    steps:
+      - uses: release-drafter/release-drafter@v7
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -1,8 +1,9 @@
 name: Release
 
 on:
-  release:
-    types: [published, prereleased]
+  push:
+    tags:
+      - 'v*'
 
 permissions:
   contents: read
@@ -14,13 +15,14 @@ env:
 jobs:
   build-release:
     runs-on: ubuntu-latest
-    # Needs write access to attach .so/.dll/.inc to the GitHub release
-    # and to amend the release body with the auto-generated notes.
+    # Needs write access to create the release and upload .so/.dll/.inc.
     permissions:
       contents: write
 
     steps:
       - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0   # full history so the generate-notes API can list every commit
 
       - name: Verify Cargo.toml version matches release tag
         run: |
@@ -70,57 +72,76 @@ jobs:
           cp "target/i686-pc-windows-msvc/release/${PLUGIN_NAME}.dll"     "dist/${PLUGIN_NAME}.dll"
           cp "include/${PLUGIN_NAME}.inc"                                 "dist/${PLUGIN_NAME}.inc"
 
-      - name: Generate release notes
+      - name: Build release body
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
-          SDK_VERSION="$(grep -oP 'tag\s*=\s*"\Kv[0-9][^"]*' Cargo.toml | head -n1)"
-          PLUGIN_VERSION="$(grep -m1 '^version' Cargo.toml | sed 's/.*= *"\(.*\)"/\1/')"
-
-          # Extract the section for the current version from CHANGELOG.md.
-          # Format: "## [X.Y.Z] — yyyy/mm/dd" up to the next "## " heading.
-          CHANGELOG_SECTION=""
-          if [ -f CHANGELOG.md ]; then
-            CHANGELOG_SECTION="$(awk -v ver="${PLUGIN_VERSION}" '
-              $0 ~ "^## \\[" ver "\\]" { capture = 1; next }
-              capture && /^## / { exit }
-              capture { print }
-            ' CHANGELOG.md)"
+          TAG="${GITHUB_REF_NAME}"
+          VERSION="${TAG#v}"
+
+          # 1. Curated section from CHANGELOG.md — headlines, migration notes,
+          # breaking changes. Everything that humans wrote and the API cannot
+          # infer from PR titles alone.
+          BODY=$(awk "/^## \[?v?${VERSION}\]?/{found=1; next} found && /^## /{exit} found{print}" CHANGELOG.md)
+          if [ -z "$BODY" ]; then
+            BODY="See [CHANGELOG.md](CHANGELOG.md) for details."
           fi
 
-          cat > release_body.md <<EOF
-          ## ${PLUGIN_NAME} v${PLUGIN_VERSION}
-
-          Built on top of [rust-samp ${SDK_VERSION}](https://github.com/NullSablex/rust-samp/releases/tag/${SDK_VERSION}).
+          # 2. Auto-generated notes — used only to borrow the "New Contributors"
+          # block and the "Full Changelog" comparison link that GitHub computes
+          # natively. The "## What's Changed" categorisation produced here is
+          # dropped on purpose; the CHANGELOG already does that job with more
+          # context.
+          AUTO=$(gh api -X POST "repos/${GITHUB_REPOSITORY}/releases/generate-notes" \
+            -f tag_name="$TAG" \
+            -q .body 2>/dev/null || echo "")
+
+          # Everything from "## New Contributors" onwards already includes the
+          # "Full Changelog" link as its last line. Fall back to just the link
+          # if no first-time contributors were detected.
+          APPENDIX=$(echo "$AUTO" | sed -n '/^## New Contributors$/,$p')
+          if [ -z "$APPENDIX" ]; then
+            APPENDIX=$(echo "$AUTO" | grep '^\*\*Full Changelog\*\*' | tail -1)
+          fi
 
+          # 3. Artifact orientation footer — what each downloadable file is,
+          # plus a pointer to the installation docs. Kept at the bottom so it
+          # doesn't push the actual release notes below the fold.
+          FOOTER=$(cat <<EOF
           ### Artifacts
+
           - \`${PLUGIN_NAME}.so\` — Linux i686 (\`i686-unknown-linux-gnu\`).
           - \`${PLUGIN_NAME}.dll\` — Windows i686 (\`i686-pc-windows-msvc\`).
           - \`${PLUGIN_NAME}.inc\` — Pawn include, identical file for SA-MP and Open Multiplayer.
 
-          ### Compatibility
-          The binaries are **universal**: they run on SA-MP and on Open Multiplayer, on Linux and Windows alike.
-
-          - **SA-MP**: drop the binary into \`plugins/\` and register it under \`plugins=\` in \`server.cfg\`.
-          - **Open Multiplayer (native mode, recommended)**: drop the binary into the server's \`components/\` folder. It is loaded automatically via \`ComponentEntryPoint\`, with access to \`ICore\`, \`ITimersComponent\` and the remaining native APIs. No \`config.json\` entry is required.
-          - **Open Multiplayer (legacy mode)**: drop the binary into \`plugins/\` and declare it under \`pawn.legacy_plugins\` in \`config.json\`. Same binary, no extra build flags.
+          The same \`.so\` / \`.dll\` runs on SA-MP and on Open Multiplayer (native component or legacy). Installation paths: see [\`docs/installation.md\`](https://github.com/${GITHUB_REPOSITORY}/blob/master/docs/installation.md).
           EOF
+          )
 
-          if [ -n "${CHANGELOG_SECTION}" ]; then
-            {
+          {
+            echo "$BODY"
+            if [ -n "$APPENDIX" ]; then
               echo ""
-              echo "### Changelog"
+              echo "---"
               echo ""
-              echo "${CHANGELOG_SECTION}"
-            } >> release_body.md
-          fi
+              echo "$APPENDIX"
+            fi
+            echo ""
+            echo "---"
+            echo ""
+            echo "$FOOTER"
+          } > release_body.md
 
           cat release_body.md
 
-      - name: Upload release assets
+      - name: Create GitHub Release
         uses: softprops/action-gh-release@v3
         with:
+          name: ${{ github.ref_name }}
           body_path: release_body.md
-          append_body: true
           files: |
             dist/${{ env.PLUGIN_NAME }}.so
             dist/${{ env.PLUGIN_NAME }}.dll
             dist/${{ env.PLUGIN_NAME }}.inc
+          draft: false
+          prerelease: false
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,8 +10,6 @@ Format inspired by [Keep a Changelog](https://keepachangelog.com/). Versioning f
 
 - `MYSQL_OPT_SSL` and `MYSQL_OPT_SSL_CA` are now wired through to the connection builder. When `MYSQL_OPT_SSL` is enabled, `mysql_connect` configures `SslOpts::default()` on the pool (rustls). When `MYSQL_OPT_SSL_CA` is also set, its path is passed to `with_root_cert_path`; otherwise the platform trust store is used. Previously both options were accepted but silently ignored, so connections were always plaintext.
 
----
-
 ## [1.1.0] — 2026/05/18
 
 Built on top of [rust-samp v3.0.0](https://github.com/NullSablex/rust-samp/releases/tag/v3.0.0). The same `.so` / `.dll` now loads on SA-MP and on Open Multiplayer (native component or legacy mode). No Pawn-visible API was removed or renamed.
@@ -72,8 +70,6 @@ Built on top of [rust-samp v3.0.0](https://github.com/NullSablex/rust-samp/relea
 - `log` removed as a direct dependency (re-exported by `samp`).
 - GitHub Actions bumped to the current major: `actions/checkout` v4 → v6, `actions/setup-python` v5 → v6, `actions/cache` v4 → v5, `actions/upload-artifact` v4 → v7, `softprops/action-gh-release` v2 → v3, `rustsec/audit-check` v2.0.0 → v2 (floats within the major for patches).
 
----
-
 ## [1.0.0] — 2026/03/09
 
 First stable release. Added ORM, cache, threaded query pipeline, full safety net.
@@ -157,8 +153,6 @@ First stable release. Added ORM, cache, threaded query pipeline, full safety net
 - UTF-8 forced via `SET NAMES utf8mb4` on every pool connection — blocks multi-byte escape-bypass attacks.
 - Auto reconnect retries dropped connections once before reporting through `OnQueryError`.
 
----
-
 ## Historical releases
 
 - [v0.x](changelog/v0.x.md) — 0.1.0
diff --git a/CNAME b/CNAME
diff --git a/RELEASE.md b/RELEASE.md
