feat(release): one release stream, one version, one page per version
CHANGELOG.archied.md and CHANGELOG.archie.md were two version streams that drifted: a release that moved both components had two numbers, two pages and two tags, and a reader had to visit two files to learn what shipped. The merged history holds 65 versions from 64 archied and 34 archie sections -- 33 that both components released, 31 only archied, one only archie -- so 98 published pages become 65. A version's date is the newest of its sections' dates, and a component whose own date differs carries it on its label, because the history has two dates and the merge must not invent one. `## [Unreleased]` is not a release: it gets no page, and it stays at the top of the file. A level-two heading is where the merge could silently drop a section, so the merge is verified by content rather than by the generator: section counts per source, the merged version set against the exact union, and every source `###` title present both as a substring and, after stripping the component prefix, as an identical heading. Counting `##` headings rather than releases overcounts by one here, which is how the empty `[Unreleased]` block was caught. - newsgen reads one file and writes `docs/news/<version>.md`, the index, the canonical `releases.json`, and `docs/news/redirects.json`. The redirect table is what keeps the retired `/news/<component>/<version>/` URLs alive; it is generated beside the pages so it cannot drift from them. - release.sh takes one `--version`, keeps commit and tag (the Woodpecker pipeline that will own them does not exist yet), and exits 3 when the commit set justifies no release, so a pipeline can finish green without tagging. - The consumers of the two files follow: the deploy workflow's tag gate and release-notes extraction, the zip contents, the update check's changelog links, the packaged-path note, the docs skill, and newsgen's tests. The per-component detail survives as labelled sections inside each release, so a reader still learns whether archied or the agent changed; what goes away is the separate numbers and the separate pages.
This commit is contained in:
1 parent
80775676eb
commit
0b408017e0
134 files changed
+3189
-3241
No files matched your search
@@ -6,7 +6,7 @@ name: deploy
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
tags: ["archied/v*", "archie/v*"]
|
||||
tags: ["archied/v*", "archie/v*", "v*"]
|
||||
|
||||
# Rapid successive pushes to main (a release commit right after its
|
||||
# preceding fix, say) previously queued a full gate+build for each one,
|
||||
@@ -46,12 +46,12 @@ jobs:
|
||||
- name: Resolve archied tag at HEAD
|
||||
id: release_tag
|
||||
run: |
|
||||
version="$(git tag --points-at HEAD --list 'archied/v*' | sed 's|^archied/v||' | sort -V | tail -1)"
|
||||
version="$(git tag --points-at HEAD --list 'archied/v*' --list 'v*' | sed -e 's|^archied/v||' -e 's|^v||' | sort -V | tail -1)"
|
||||
echo "archied_version=$version" >> "$GITHUB_OUTPUT"
|
||||
if [ -n "$version" ]; then
|
||||
echo "archied release at HEAD: $version"
|
||||
else
|
||||
echo "no archied tag at HEAD; distribution zip will be skipped"
|
||||
echo "no release tag at HEAD; distribution zip will be skipped"
|
||||
fi
|
||||
|
||||
- name: Set up Go
|
||||
@@ -111,21 +111,22 @@ jobs:
|
||||
fail=0
|
||||
for tag in $(git tag --points-at HEAD); do
|
||||
case "$tag" in
|
||||
archied/v*)
|
||||
# Strip the "v" too: tags are archied/vX.Y.Z, changelog
|
||||
# sections are "## [X.Y.Z]" (see tools/release.sh).
|
||||
ver="${tag#archied/v}"
|
||||
echo " archied tag $tag -> looking for [$ver] in CHANGELOG.archied.md"
|
||||
grep -q "^## \\[$ver\\]" CHANGELOG.archied.md || {
|
||||
echo " FAIL: CHANGELOG.archied.md has no [$ver] section"
|
||||
v*)
|
||||
ver="${tag#v}"
|
||||
echo " release tag $tag -> looking for [$ver] in CHANGELOG.md"
|
||||
grep -q "^## \\[$ver\\]" CHANGELOG.md || {
|
||||
echo " FAIL: CHANGELOG.md has no [$ver] section"
|
||||
fail=1
|
||||
}
|
||||
;;
|
||||
archie/v*)
|
||||
ver="${tag#archie/v}"
|
||||
echo " archie tag $tag -> looking for [$ver] in CHANGELOG.archie.md"
|
||||
grep -q "^## \\[$ver\\]" CHANGELOG.archie.md || {
|
||||
echo " FAIL: CHANGELOG.archie.md has no [$ver] section"
|
||||
archied/v* | archie/v*)
|
||||
# Legacy per-component tags. History is not re-tagged, and the
|
||||
# merged CHANGELOG.md carries every component's versions, so the
|
||||
# section is found there rather than in a component file.
|
||||
ver="${tag#*/v}"
|
||||
echo " legacy tag $tag -> looking for [$ver] in CHANGELOG.md"
|
||||
grep -q "^## \\[$ver\\]" CHANGELOG.md || {
|
||||
echo " FAIL: CHANGELOG.md has no [$ver] section"
|
||||
fail=1
|
||||
}
|
||||
;;
|
||||
@@ -290,7 +291,7 @@ jobs:
|
||||
name="archie-core-archied-v${{ steps.version.outputs.version }}-linux-amd64"
|
||||
mkdir -p "$name"
|
||||
cp dist/archied dist/archie-gateway dist/archie-state-store dist/archie-ui dist/archie-messaging dist/archie-playbooks "$name/"
|
||||
cp deployments/INSTRUCTIONS.md CHANGELOG.md CHANGELOG.archied.md CHANGELOG.archie.md "$name/"
|
||||
cp deployments/INSTRUCTIONS.md CHANGELOG.md "$name/"
|
||||
# README.md doesn't exist yet in this repo; include it once it does
|
||||
# rather than fail the release on its absence.
|
||||
[ -f README.md ] && cp README.md "$name/"
|
||||
@@ -332,9 +333,9 @@ jobs:
|
||||
index($0, hdr) == 1 { printing = 1 }
|
||||
printing && /^## \[/ && index($0, hdr) != 1 { exit }
|
||||
printing { print }
|
||||
' CHANGELOG.archied.md > "$notes"
|
||||
' CHANGELOG.md > "$notes"
|
||||
if ! [ -s "$notes" ]; then
|
||||
echo "no [$version] section extracted from CHANGELOG.archied.md" >&2
|
||||
echo "no [$version] section extracted from CHANGELOG.md" >&2
|
||||
exit 1
|
||||
fi
|
||||
# Idempotent: --clobber replaces the asset and leaves the notes
|
||||
|
||||
Reference in new issue
Block a user