You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: FCVW/VERSIONING.md
+21-1Lines changed: 21 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Versioning and Changelogs
2
2
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)
4
4
5
5
This document defines the versioning, release, and changelog rules of the application.
6
6
@@ -82,6 +82,8 @@ The file must be created or updated before closing the plan.
82
82
83
83
No version should be considered completed without a corresponding changelog.
84
84
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
+
85
87
## Naming Pattern
86
88
87
89
```text
@@ -107,6 +109,10 @@ YYYY-MM-DD
107
109
108
110
`in_preparation`
109
111
112
+
## GitHub Release Status
113
+
114
+
`not_applicable | pending | published`
115
+
110
116
## Release Type
111
117
112
118
`major` / `minor` / `patch`
@@ -175,6 +181,16 @@ YYYY-MM-DD
175
181
-`published`: release completed and recorded as official version.
176
182
-`canceled`: release planned, but not published.
177
183
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
+
178
194
## Release Types
179
195
180
196
-`major`: increment of `x`.
@@ -188,12 +204,14 @@ Each relevant changelog item must point to one or more plans in `Plans/`.
188
204
- Completed plans must be cited by filename.
189
205
- In-progress plans must not be treated as completed.
190
206
- 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.
191
208
192
209
## Criteria to Publish a Version
193
210
194
211
A version can only be marked as `published` when:
195
212
196
213
- all included plans are in `Plans/completed/`;
214
+
- all included plans have internal `Status: completed`;
197
215
- the changelog exists and lists created, modified, and removed items;
198
216
- the validation defined in the plans has been executed or the limitation is documented;
199
217
- 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,
209
227
- Does the `changelogs/Vx.y.z.md` file exist?
210
228
- Does the filename correspond to the **Version** field?
211
229
- Do all cited plans exist and reside in `Plans/completed/`?
230
+
- Do all cited completed plans have internal `Status: completed`?
212
231
- Were created, modified, and removed files listed?
213
232
- Were justifications and validations recorded?
214
233
- Are known gaps explicit?
234
+
- Is `GitHub Release Status` present and accurate?
0 commit comments