Skip to content

RELEASE.md

Latest commit

 

History

History
83 lines (64 loc) · 4.16 KB

RELEASE.md

File metadata and controls

83 lines (64 loc) · 4.16 KB

CombatMode Release Checklist

Use this checklist when preparing a release build.

1) Version and metadata

  • Update addon version in CombatMode/CombatMode.toc (and any mirrored version fields).
  • Verify ## Interface targets current Retail build.
  • Confirm addon title/notes/author metadata are accurate.
  • Confirm CombatMode/CombatMode.toc addon folder/name metadata still matches CombatMode packaging expectations.

Release automation setup (WoW Packager)

  • GitHub release packaging and publishing is handled by .github/workflows/release-package.yml using BigWigsMods/packager@v2.
  • Required repository secret:
    • CF_API_KEY: CurseForge API token used for upload.
  • Required repository variable:
    • CURSEFORGE_PROJECT_ID: numeric CurseForge project ID.
  • Wago upload is intentionally not configured yet.
  • Root .pkgmeta sets package-as, ignore, and manual-changelog (packager uses -t CombatMode -m .pkgmeta).
  • Maintain CombatMode/CHANGELOG.md manually and commit it before tagging/publishing a release; the packager includes it in the zip via .pkgmeta (manual-changelog: CHANGELOG.md under -t CombatMode).
  • Regenerate the in-game viewer copy by running scripts/sync-changelog-to-lua.ps1 (or VS Code task Sync CHANGELOG.md to ConfigChangelogData.lua) so CombatMode/Config/ConfigChangelogData.lua (CM.Config.ChangelogText) stays aligned with CHANGELOG.md.

2) API and compatibility checks

  • MCP-first (preferred):
    • Validate new/changed WoW API calls (lookup_api).
    • Check deprecated APIs and replacements (list_deprecated).
    • Confirm enums/events where relevant (get_enum, get_event).
  • Manual fallback (no MCP available):
    • Verify each changed API/event on warcraft.wiki.gg API docs.
    • Confirm events used in CM.Constants.BLIZZARD_EVENTS have correct payload expectations for handlers.
    • Manually review protected-action APIs (SetBinding, SetOverrideBinding*, SetMouselookOverrideBinding, CVar writes) for combat guards/deferred handling.
  • Prefer Mainline-safe behavior unless explicitly shipping cross-version logic.

3) Load order and packaging sanity

  • Confirm CombatMode/Embeds.xml load order still matches module dependencies.
  • Ensure new files are included in CombatMode/Embeds.xml and/or CombatMode/CombatMode.toc as needed.
  • Verify no accidental dev-only artifacts are referenced.
  • GitHub source archives (Source code (zip/tar.gz)) include the full repository and are not addon-ready packaging.
  • Confirm the published release includes the workflow-generated asset CombatMode-<version>.zip (for example CombatMode-3.1.6.zip) and use that as the distributable.

4) Functional smoke test

  • Run quick pass from TESTING.md:
    • core mouselook toggle/lock/unlock flow
    • reticle + targeting CVar behavior
    • click-casting base/modifier paths
    • healing radial open/cast flow
    • slash commands and keybind sanity
  • Confirm no combat-lockdown errors and no new Lua errors.
  • If MCP was unavailable during implementation, run an additional manual API spot-check for each changed WoW API call before tagging release.
  • Run full lint/format gate for release prep: pre-commit run --all-files.

5) Settings and persistence

  • Verify new settings have defaults and correct DB scope (global or char).
  • Reload UI and ensure values persist and re-apply correctly.
  • Confirm reset/default flows remain valid.

6) Changelog and release notes

  • Summarize user-visible changes first (features/fixes/behavior changes).
  • Note any keybind, CVar, or migration-impacting changes explicitly.
  • Include known limitations or follow-up items if any.

7) Post-release verification (CurseForge-first flow)

  • Publish a GitHub release tag (draft/prerelease is fine for validation).
  • Confirm the Release Package workflow run succeeds in GitHub Actions.
  • Confirm the GitHub release has the workflow-generated package asset attached.
  • Confirm a new file appears on CurseForge for CURSEFORGE_PROJECT_ID with the expected version/tag.

Suggested changelog format

## x.y.z
- Feature: ...
- Fix: ...
- Improvement: ...
- Notes: (migrations, known caveats)