Skip to content

Commit 360ebc8

Browse files
committed
docs(versioning): update current version and changelog schema
1 parent 2dad044 commit 360ebc8

1 file changed

Lines changed: 21 additions & 1 deletion

File tree

FCVW/VERSIONING.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Versioning and Changelogs
22

3-
> **Current version: `V0.10.2`** - see [`changelogs/V0.10.2.md`](changelogs/V0.10.2.md)
3+
> **Current version: `V0.10.3`** - see [`changelogs/V0.10.3.md`](changelogs/V0.10.3.md)
44
55
This document defines the versioning, release, and changelog rules of the application.
66

@@ -82,6 +82,8 @@ The file must be created or updated before closing the plan.
8282

8383
No version should be considered completed without a corresponding changelog.
8484

85+
The `release-checklist` skill must be loaded whenever a task creates or edits `changelogs/Vx.y.z.md`, bumps a version field, marks a changelog as `published`, prepares a tag, or publishes a GitHub release.
86+
8587
## Naming Pattern
8688

8789
```text
@@ -107,6 +109,10 @@ YYYY-MM-DD
107109

108110
`in_preparation`
109111

112+
## GitHub Release Status
113+
114+
`not_applicable | pending | published`
115+
110116
## Release Type
111117

112118
`major` / `minor` / `patch`
@@ -175,6 +181,16 @@ YYYY-MM-DD
175181
- `published`: release completed and recorded as official version.
176182
- `canceled`: release planned, but not published.
177183

184+
## GitHub Release Status
185+
186+
Use this field to avoid ambiguity between a formal changelog publication and an external GitHub Release/tag publication:
187+
188+
- `not_applicable`: the changelog is published, but no GitHub Release/tag was required or performed.
189+
- `pending`: the GitHub Release/tag is expected but not yet completed.
190+
- `published`: the GitHub Release/tag was created and verified.
191+
192+
Do not mark GitHub release status as `published` without evidence of tag/release creation.
193+
178194
## Release Types
179195

180196
- `major`: increment of `x`.
@@ -188,12 +204,14 @@ Each relevant changelog item must point to one or more plans in `Plans/`.
188204
- Completed plans must be cited by filename.
189205
- In-progress plans must not be treated as completed.
190206
- Discontinued plans only enter the changelog if they affected decisions, files, or scope.
207+
- The plan's internal **Status** field must match the directory where the plan resides.
191208

192209
## Criteria to Publish a Version
193210

194211
A version can only be marked as `published` when:
195212

196213
- all included plans are in `Plans/completed/`;
214+
- all included plans have internal `Status: completed`;
197215
- the changelog exists and lists created, modified, and removed items;
198216
- the validation defined in the plans has been executed or the limitation is documented;
199217
- version references in code, documentation, and build are coherent;
@@ -209,6 +227,8 @@ When a release alters code, persisted data, build, migration, or API contracts,
209227
- Does the `changelogs/Vx.y.z.md` file exist?
210228
- Does the filename correspond to the **Version** field?
211229
- Do all cited plans exist and reside in `Plans/completed/`?
230+
- Do all cited completed plans have internal `Status: completed`?
212231
- Were created, modified, and removed files listed?
213232
- Were justifications and validations recorded?
214233
- Are known gaps explicit?
234+
- Is `GitHub Release Status` present and accurate?

0 commit comments

Comments
 (0)