@@ -12,9 +12,11 @@ Gather the following before proceeding:
1212
13131 . ** Current version:** Read ` pyproject.toml ` and extract the ` version = "..." ` line.
14142 . ** Current branch:** Run ` git branch --show-current ` .
15- 3 . ** Last tag:** Run ` git describe --tags --abbrev=0 ` .
16- 4 . ** Commits since last tag:** Run ` git log <last-tag>..HEAD --oneline ` .
17- 5 . ** Files changed since last tag:** Run ` git diff <last-tag>..HEAD --name-only | sort ` .
15+ 3 . ** Last NexusLIMS-CDCS tag:** Run ` git tag --sort=-version:refname | grep -E '\-nx[0-9]+$' | head -1 ` .
16+ ** IMPORTANT:** Only use tags with a ` -nx{N} ` suffix (e.g. ` 3.18.0-nx1 ` ). Never use bare upstream
17+ CDCS version tags like ` 3.20.0 ` -- those mark upstream releases, not NexusLIMS-CDCS releases.
18+ 4 . ** Commits since last tag:** Run ` git log <last-nx-tag>..HEAD --oneline ` .
19+ 5 . ** Files changed since last tag:** Run ` git diff <last-nx-tag>..HEAD --name-only | sort ` .
1820
1921Gather all five before proceeding.
2022
@@ -25,7 +27,7 @@ Gather all five before proceeding.
2527### Step 1: Analyse Changed Files for Upgrade Impact
2628
2729Scan the changed file list and categorise each into the buckets below. For any bucket
28- that has matches, read the actual diff (` git diff <last-tag>..HEAD -- <file> ` ) to
30+ that has matches, read the actual diff (` git diff <last-nx- tag>..HEAD -- <file> ` ) to
2931understand * what* changed so you can write concrete upgrade instructions.
3032
3133| Bucket | Patterns | Deployment impact |
@@ -208,17 +210,18 @@ Once approved, and unless `--dry-run` was passed:
2082101. **Update `pyproject.toml`**: Set `version = "<VERSION>"` using the PEP 440 local
209211 form (e.g. `3.20.0+nx1` for tag `v3.20.0-nx1`).
210212
211- 2. **Write `RELEASE_NOTES.md`** to the project root with the approved release notes.
212-
213- 3. **Commit both files:**
213+ 2. **Commit only `pyproject.toml`** -- do NOT write or commit a `RELEASE_NOTES.md` file:
214214 ```bash
215- git add pyproject.toml RELEASE_NOTES.md
215+ git add pyproject.toml
216216 git commit -m "chore: release vVERSION"
217217 ```
218218
219- 4 . ** Tag the release** (hyphen form):
219+ 3 . ** Tag the release** (hyphen form), embedding the full release notes in the tag annotation :
220220 ``` bash
221- git tag -a vVERSION -m " Release vVERSION"
221+ git tag -a vVERSION -m " $( cat << 'EOF '
222+ <full release notes here>
223+ EOF
224+ )"
222225 ```
223226
2242275. **Push** (unless `--no-push` was passed):
0 commit comments