From 831685dbd7755297660b38ab239a85811b069e19 Mon Sep 17 00:00:00 2001 From: Corfirean Date: Sat, 3 Oct 2026 07:05:07 +0500 Subject: [PATCH] Changelog fragments (changelog.d) and the shared rules for people and AIs Rules and format: https://github.com/Corfirean/coa-server-build/blob/main/changelog/GUIDE.md Co-Authored-By: Claude Sonnet 5.5 --- .github/workflows/changelog.yml | 14 +++++++++ AGENTS.md | 31 +++++++++++++++++++ CLAUDE.md | 1 + GEMINI.md | 1 + ...ons-tab-with-transmog-vanity-riding-and.md | 6 ++++ ...-bots-are-recognised-from-their-default.md | 6 ++++ ...delete-an-account-from-the-players-page.md | 7 +++++ ...-a-server-suggests-the-right-folder-whe.md | 6 ++++ ...age-with-cards-status-badges-and-per-mo.md | 7 +++++ ...problem-collects-more-and-ignores-repea.md | 6 ++++ ...ttings-in-one-panel-with-search-tabs-an.md | 6 ++++ ...e-check-says-you-are-up-to-date-instead.md | 6 ++++ ...servers-get-the-module-config-files-the.md | 7 +++++ ...003-modules-marked-soon-stay-greyed-out.md | 6 ++++ ...page-is-hidden-when-the-module-is-not-o.md | 6 ++++ ...the-game-client-shows-a-progress-bar-on.md | 7 +++++ changelog.d/README.md | 7 +++++ 17 files changed, 130 insertions(+) create mode 100644 .github/workflows/changelog.yml create mode 100644 AGENTS.md create mode 100644 CLAUDE.md create mode 100644 GEMINI.md create mode 100644 changelog.d/20261002-collections-tab-with-transmog-vanity-riding-and.md create mode 100644 changelog.d/20261002-companion-bots-are-recognised-from-their-default.md create mode 100644 changelog.d/20261002-delete-an-account-from-the-players-page.md create mode 100644 changelog.d/20261002-importing-a-server-suggests-the-right-folder-whe.md create mode 100644 changelog.d/20261002-modules-page-with-cards-status-badges-and-per-mo.md create mode 100644 changelog.d/20261002-report-a-problem-collects-more-and-ignores-repea.md create mode 100644 changelog.d/20261002-server-settings-in-one-panel-with-search-tabs-an.md create mode 100644 changelog.d/20261002-the-update-check-says-you-are-up-to-date-instead.md create mode 100644 changelog.d/20261003-imported-servers-get-the-module-config-files-the.md create mode 100644 changelog.d/20261003-modules-marked-soon-stay-greyed-out.md create mode 100644 changelog.d/20261003-the-bots-page-is-hidden-when-the-module-is-not-o.md create mode 100644 changelog.d/20261003-updating-the-game-client-shows-a-progress-bar-on.md create mode 100644 changelog.d/README.md diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml new file mode 100644 index 0000000..2b31708 --- /dev/null +++ b/.github/workflows/changelog.yml @@ -0,0 +1,14 @@ +name: changelog +# Checks the changelog.d/ fragment files with the shared rules (https://github.com/Corfirean/coa-server-build/blob/main/changelog/GUIDE.md). +on: + push: + paths: ['changelog.d/**'] + pull_request: + paths: ['changelog.d/**'] + +permissions: + contents: read + +jobs: + check: + uses: Corfirean/coa-server-build/.github/workflows/changelog-check.yml@main diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..443d4ec --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,31 @@ +# AGENTS.md + + +## Changelog (shared by all CoA repositories) + +Every CoA project (server fork, bots, Content Scaling, Manager, renderer) feeds **one** changelog that is posted to the +community. When you finish a change that a **player** or a **server owner** would notice (a new feature, a changed +behaviour, a fix for something people ran into, a removed feature, a known issue), add **one small file to +`changelog.d/` in the same commit**. Do not add one for internal work (refactors, tests, CI, documentation). + +File name: `YYYYMMDD-short-slug.md` (today's date). Content: + +``` +--- +area: bots # server | bots | scaling | modules | manager | addon | client | renderer +type: fixed # added | changed | fixed | removed | known-issue +audience: players # players | admins (admins = people who run a server or use the Manager) +title: Bots no longer take Realm First achievements +--- +Optional: one short paragraph in plain English for the reader (at most 300 characters). +``` + +- English only. The title says what changed **for the reader**, not how (at most 90 characters, starts with a capital, + no full stop). No code names, file names or commit language in the title. +- One file per change. Never edit or delete files that are already released; never write version numbers (the release + step adds them). +- Check your file: `python changelog.py check --dir changelog.d` (download the script from + https://raw.githubusercontent.com/Corfirean/coa-server-build/main/changelog/changelog.py ), or create it with + `python changelog.py new --area bots --type fixed --audience players --title "..."`. +- Full guide with examples: https://github.com/Corfirean/coa-server-build/blob/main/changelog/GUIDE.md + diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..43c994c --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1 @@ +@AGENTS.md diff --git a/GEMINI.md b/GEMINI.md new file mode 100644 index 0000000..43c994c --- /dev/null +++ b/GEMINI.md @@ -0,0 +1 @@ +@AGENTS.md diff --git a/changelog.d/20261002-collections-tab-with-transmog-vanity-riding-and.md b/changelog.d/20261002-collections-tab-with-transmog-vanity-riding-and.md new file mode 100644 index 0000000..813e4d7 --- /dev/null +++ b/changelog.d/20261002-collections-tab-with-transmog-vanity-riding-and.md @@ -0,0 +1,6 @@ +--- +area: manager +type: added +audience: admins +title: Collections tab with transmog, vanity, riding and companion switches +--- diff --git a/changelog.d/20261002-companion-bots-are-recognised-from-their-default.md b/changelog.d/20261002-companion-bots-are-recognised-from-their-default.md new file mode 100644 index 0000000..ec57206 --- /dev/null +++ b/changelog.d/20261002-companion-bots-are-recognised-from-their-default.md @@ -0,0 +1,6 @@ +--- +area: manager +type: fixed +audience: admins +title: Companion bots are recognised from their default config file +--- diff --git a/changelog.d/20261002-delete-an-account-from-the-players-page.md b/changelog.d/20261002-delete-an-account-from-the-players-page.md new file mode 100644 index 0000000..640a3d7 --- /dev/null +++ b/changelog.d/20261002-delete-an-account-from-the-players-page.md @@ -0,0 +1,7 @@ +--- +area: manager +type: added +audience: admins +title: Delete an account from the Players page +--- +You type the account name to confirm; online and system accounts are refused. diff --git a/changelog.d/20261002-importing-a-server-suggests-the-right-folder-whe.md b/changelog.d/20261002-importing-a-server-suggests-the-right-folder-whe.md new file mode 100644 index 0000000..197177e --- /dev/null +++ b/changelog.d/20261002-importing-a-server-suggests-the-right-folder-whe.md @@ -0,0 +1,6 @@ +--- +area: manager +type: changed +audience: admins +title: Importing a server suggests the right folder when you pick the wrong one +--- diff --git a/changelog.d/20261002-modules-page-with-cards-status-badges-and-per-mo.md b/changelog.d/20261002-modules-page-with-cards-status-badges-and-per-mo.md new file mode 100644 index 0000000..1083346 --- /dev/null +++ b/changelog.d/20261002-modules-page-with-cards-status-badges-and-per-mo.md @@ -0,0 +1,7 @@ +--- +area: manager +type: added +audience: admins +title: Modules page with cards, status badges and per-module settings +--- +Switch the companion bots and NPC Enchanter on and off; a module's settings open under its card. diff --git a/changelog.d/20261002-report-a-problem-collects-more-and-ignores-repea.md b/changelog.d/20261002-report-a-problem-collects-more-and-ignores-repea.md new file mode 100644 index 0000000..2560ef5 --- /dev/null +++ b/changelog.d/20261002-report-a-problem-collects-more-and-ignores-repea.md @@ -0,0 +1,6 @@ +--- +area: manager +type: changed +audience: admins +title: Report a problem collects more and ignores repeated config warnings +--- diff --git a/changelog.d/20261002-server-settings-in-one-panel-with-search-tabs-an.md b/changelog.d/20261002-server-settings-in-one-panel-with-search-tabs-an.md new file mode 100644 index 0000000..ac02d37 --- /dev/null +++ b/changelog.d/20261002-server-settings-in-one-panel-with-search-tabs-an.md @@ -0,0 +1,6 @@ +--- +area: manager +type: changed +audience: admins +title: Server settings in one panel with search, tabs and a single Save bar +--- diff --git a/changelog.d/20261002-the-update-check-says-you-are-up-to-date-instead.md b/changelog.d/20261002-the-update-check-says-you-are-up-to-date-instead.md new file mode 100644 index 0000000..167f4b8 --- /dev/null +++ b/changelog.d/20261002-the-update-check-says-you-are-up-to-date-instead.md @@ -0,0 +1,6 @@ +--- +area: manager +type: fixed +audience: admins +title: The update check says you are up to date instead of offering the same version +--- diff --git a/changelog.d/20261003-imported-servers-get-the-module-config-files-the.md b/changelog.d/20261003-imported-servers-get-the-module-config-files-the.md new file mode 100644 index 0000000..0efdac8 --- /dev/null +++ b/changelog.d/20261003-imported-servers-get-the-module-config-files-the.md @@ -0,0 +1,7 @@ +--- +area: manager +type: fixed +audience: admins +title: Imported servers get the module config files they lack +--- +They are created at start and after an update; existing files are never changed. diff --git a/changelog.d/20261003-modules-marked-soon-stay-greyed-out.md b/changelog.d/20261003-modules-marked-soon-stay-greyed-out.md new file mode 100644 index 0000000..0ad10f9 --- /dev/null +++ b/changelog.d/20261003-modules-marked-soon-stay-greyed-out.md @@ -0,0 +1,6 @@ +--- +area: manager +type: fixed +audience: admins +title: Modules marked Soon stay greyed out +--- diff --git a/changelog.d/20261003-the-bots-page-is-hidden-when-the-module-is-not-o.md b/changelog.d/20261003-the-bots-page-is-hidden-when-the-module-is-not-o.md new file mode 100644 index 0000000..8ac2d45 --- /dev/null +++ b/changelog.d/20261003-the-bots-page-is-hidden-when-the-module-is-not-o.md @@ -0,0 +1,6 @@ +--- +area: manager +type: fixed +audience: admins +title: The Bots page is hidden when the module is not on the server +--- diff --git a/changelog.d/20261003-updating-the-game-client-shows-a-progress-bar-on.md b/changelog.d/20261003-updating-the-game-client-shows-a-progress-bar-on.md new file mode 100644 index 0000000..471ae6f --- /dev/null +++ b/changelog.d/20261003-updating-the-game-client-shows-a-progress-bar-on.md @@ -0,0 +1,7 @@ +--- +area: manager +type: changed +audience: admins +title: Updating the game client shows a progress bar on its button +--- +No window covers the app while the client updates. diff --git a/changelog.d/README.md b/changelog.d/README.md new file mode 100644 index 0000000..babfeac --- /dev/null +++ b/changelog.d/README.md @@ -0,0 +1,7 @@ +# changelog.d + +One small Markdown file per change that a player or a server owner would notice. They are collected from every CoA +repository when a release is made. The rules and the file format are in `AGENTS.md` (section "Changelog") and, in full, +in https://github.com/Corfirean/coa-server-build/blob/main/changelog/GUIDE.md + +This README is ignored by the collector.