Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
# Store text files with LF line endings; check them out as the platform prefers.
* text=auto
# Artifact source text is identical on Windows and POSIX checkouts.
BuffRadar/** text=auto eol=lf
editions/forever/** text=auto eol=lf
# Media files are binary: never touch their bytes.
*.png binary
*.jpg binary
*.jpeg binary
*.ogg binary
*.zip binary
35 changes: 34 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,42 @@ jobs:
python-version: "3.12"
- run: |
python -m pip install --only-binary=:all: lupa==2.8
- name: Gate (static checks + smoke on six fake-client setups)
- name: Gate (static checks and Lua 5.1 fake-client suites)
run: sh tools/gate.sh
- name: Package (dry run)
run: sh tools/package.sh
- name: Verify packaged Forever load order and bindings
run: python -I tools/checkpackage.py dist/BuffRadar-*-Forever.zip .
- name: Save POSIX digest for comparison
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
with:
name: forever-posix-digest
path: dist/SHA256SUMS.txt
if-no-files-found: error
windows-package:
needs: gate
runs-on: windows-latest
steps:
- uses: actions/checkout@v5
- uses: actions/setup-python@v6
with:
python-version: "3.12"
- name: Install Lua 5.1 test dependency
run: |
python -m pip install --only-binary=:all: lupa==2.8
- run: ./build.ps1
- name: Verify packaged Forever load order and bindings
shell: pwsh
run: |
$zip = Get-ChildItem dist/BuffRadar-*-Forever.zip
python -I tools/checkpackage.py $zip.FullName .
- uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5.0.0
with:
name: forever-posix-digest
path: posix
- name: Compare the Windows and POSIX package digests
shell: pwsh
run: |
if ((Get-Content dist/SHA256SUMS.txt -Raw) -cne (Get-Content posix/SHA256SUMS.txt -Raw)) {
throw 'Package bytes differ across platforms.'
}
9 changes: 3 additions & 6 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,8 @@ jobs:
- run: |
python -m pip install --only-binary=:all: lupa==2.8
- run: sh tools/gate.sh
- name: Tag must match the TOC version
run: |
VER="$(sed -n 's/^## Version:[[:space:]]*//p' editions/forever/BuffRadar.toc | head -1 | tr -d '\r')"
[ "v$VER" = "${GITHUB_REF_NAME}" ] || { echo "tag ${GITHUB_REF_NAME} != TOC version v$VER"; exit 1; }
- run: sh tools/package.sh
- name: Verify tag and build package
run: sh tools/package.sh --tag "$GITHUB_REF_NAME"
- name: Verify packaged Forever load order and bindings
run: python -I tools/checkpackage.py dist/BuffRadar-*-Forever.zip .
- name: Collect release notes
Expand Down Expand Up @@ -52,7 +49,7 @@ jobs:
export GH_REPO="$GITHUB_REPOSITORY"
(cd dist && sha256sum -c SHA256SUMS.txt)
if gh release view "${GITHUB_REF_NAME}" >/dev/null 2>&1; then
gh release upload "${GITHUB_REF_NAME}" dist/BuffRadar-*-Forever.zip dist/SHA256SUMS.txt --clobber
echo "Release already exists; verify the hosted bytes without replacing assets."
else
gh release create "${GITHUB_REF_NAME}" dist/BuffRadar-*-Forever.zip dist/SHA256SUMS.txt \
--title "BuffRadar ${GITHUB_REF_NAME#v}" --notes-file dist/notes.md --verify-tag
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# Release zips made by build.ps1 (attach them to a GitHub release instead)
dist
dist/

# Local handoff artifacts for field testing (do not commit ZIPs).
/release-candidates/
31 changes: 20 additions & 11 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,24 @@ key) to buff them.

Frozen foundation: both editions share the Lua source under `BuffRadar/`.
Their `.toc` files declare load order; do not use `require` or add globals for
module communication. `Data.lua` initializes the addon namespace, `SavedVariables.lua`
module communication. `Forever.lua` identifies the shipping edition, `Data.lua` checks the client
and initializes the addon namespace, and `SavedVariables.lua`
owns the schema and publishes the live DB, `BuffRadar.lua` owns scanning and
cast decisions, and `Window.lua` and `Minimap.lua` own their frames and caches.
Keep implementation state local and share entry points through the addon table.
`BuffRadarAPI` is a versioned, read-only external interface, not a module bridge.
Every feature is reachable through `/br` as well as through its settings control
where it has one. SavedVariables are versioned (`dbVersion`, currently 22) with
where it has one. SavedVariables are versioned (`dbVersion`, currently 23) with
migration smoke fixtures; keep those fixtures in sync with format changes.
Never overwrite a newer schema with an older addon. Bound saved collections
at their writers as well as at load, and preserve over-limit user profiles
and permanent ignores for explicit recovery.

Build: none (interpreted Lua 5.1).
Full gate (all of it, every time, output read): `sh tools/gate.sh` runs the Lua
5.1 compiler, advisory limit estimates, locale and pattern checks, seven
fake-client smoke setups using the two TOCs, and two-client coordination.
fake-client smoke setups using the two TOCs, two-client coordination, and
packaging regressions.
`sh tools/install-hooks.sh` installs the pre-push gate. Also run real luacheck
1.2.0 on all addon Lua files (0 warnings / 0 errors); `tools/check.ps1` runs the
checks on Windows. Add trial steps for every feature in the setups it applies to.
Expand All @@ -38,16 +43,20 @@ called done; in-game behaviour is labelled **Unverified** until SEAN's field tes
proves it (evidence labels: Verified / Partially Verified / Unverified).

Special rules for this project:
- Manual Forever release validation: run docs/FOREVER_RELEASE_CHECKLIST.md on the exact candidate build before marking in-game behavior verified.
- Manual Forever release validation: use `docs/FOREVER_RELEASE_CHECKLIST.md`
and record the exact candidate ZIP digest, Windows parity result and game
build. An offline pass is not a Forever field pass.
- Secure action buttons: `HookScript` / `WrapScript` only — **never**
`SetScript("OnClick")` on a secure button.
- **CI runs the gate** (`.github/workflows/ci.yml`, added in 1.13.0): static checks + trial run + a packaging dry run on every push/PR. Real luacheck 1.2.0 stays a local Windows step (`tools/check.ps1`) — SEAN skipped it in CI on 2026-11-08. `release.yml` publishes on a `v*` tag that must equal the Forever .toc version.
- Publishing: one `push_files` snapshot via the GitHub connector (the Contents
API's per-call size cap cannot carry `BuffRadar.lua`), then blob-verify every
published file against the local tree. **Forever-only from 1.8.0** (SEAN
dropped Retail support 2026-10-25; Retail docs stay frozen at 1.7.0):
releases attach the Forever zip plus `SHA256SUMS.txt`, and are not shipped
until the assets are re-downloaded and hash-verified.
- **CI runs the gate** (`.github/workflows/ci.yml`) on main pushes and PRs.
The Windows and POSIX wrappers call `tools/package.py`; CI compares their
digests. Real luacheck 1.2.0 remains a separate local check (included in
`tools/check.ps1` on Windows), not a CI dependency.
- **Publishing:** keep the Retail docs frozen at 1.7.0; only the Forever ZIP
ships. Verify the release source against the tested tree. `release.yml` runs
on a `v*` tag matching the Forever TOC, publishes the ZIP and `SHA256SUMS.txt`,
and checks the downloaded assets against the packaged bytes. Do not treat a
successful upload as a verified release.
- The German locale stays complete — `tools/localecheck.py` enforces it; new
user-facing list tags need an `L[...]` entry and a deDE translation.
- Licence is GPLv3 (upstream author Malikor). The SEAN-annex MIT default does
Expand Down
Loading
Loading