mirror of
https://github.com/Corfirean/coa-server-manager.git
synced 2026-11-11 03:51:01 +00:00
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 <noreply@anthropic.com>
This commit is contained in:
1 parent
5c21ef106d
commit
831685dbd7
17 files changed
+130
No files matched your search
@@ -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
|
||||
@@ -0,0 +1,31 @@
|
||||
# AGENTS.md
|
||||
|
||||
<!-- changelog:start (managed by coa-server-build/changelog/changelog.py sync-instructions) -->
|
||||
## 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
|
||||
<!-- changelog:end -->
|
||||
@@ -0,0 +1,6 @@
|
||||
---
|
||||
area: manager
|
||||
type: added
|
||||
audience: admins
|
||||
title: Collections tab with transmog, vanity, riding and companion switches
|
||||
---
|
||||
@@ -0,0 +1,6 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Companion bots are recognised from their default config file
|
||||
---
|
||||
@@ -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.
|
||||
@@ -0,0 +1,6 @@
|
||||
---
|
||||
area: manager
|
||||
type: changed
|
||||
audience: admins
|
||||
title: Importing a server suggests the right folder when you pick the wrong one
|
||||
---
|
||||
@@ -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.
|
||||
@@ -0,0 +1,6 @@
|
||||
---
|
||||
area: manager
|
||||
type: changed
|
||||
audience: admins
|
||||
title: Report a problem collects more and ignores repeated config warnings
|
||||
---
|
||||
@@ -0,0 +1,6 @@
|
||||
---
|
||||
area: manager
|
||||
type: changed
|
||||
audience: admins
|
||||
title: Server settings in one panel with search, tabs and a single Save bar
|
||||
---
|
||||
@@ -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
|
||||
---
|
||||
@@ -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.
|
||||
@@ -0,0 +1,6 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Modules marked Soon stay greyed out
|
||||
---
|
||||
@@ -0,0 +1,6 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: The Bots page is hidden when the module is not on the server
|
||||
---
|
||||
@@ -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.
|
||||
@@ -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.
|
||||
Reference in new issue
Block a user