Skip to content

Commit 42e3e75

Browse files
committed
Remove duplicate changelog
1 parent c7b265c commit 42e3e75

3 files changed

Lines changed: 5 additions & 40 deletions

File tree

.github/workflows/release.yml

Lines changed: 1 addition & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -69,29 +69,11 @@ jobs:
6969
exit 1
7070
fi
7171
72-
awk -v heading="## ${version} " '
73-
index($0, heading) == 1 { found = 1; next }
74-
found && /^## / { exit }
75-
found { print }
76-
END { if (!found) exit 1 }
77-
' CHANGELOG.md > release-notes.md
78-
if [[ ! -s release-notes.md ]]; then
79-
echo "CHANGELOG.md does not contain non-empty notes for ${version}" >&2
80-
exit 1
81-
fi
82-
8372
{
8473
echo "version=${version}"
8574
echo "target=${target}"
8675
} >> "${GITHUB_OUTPUT}"
8776
88-
- name: Upload release notes
89-
uses: actions/upload-artifact@v7
90-
with:
91-
name: release-notes
92-
path: release-notes.md
93-
if-no-files-found: error
94-
9577
build-binaries:
9678
name: Build Binaries (${{ matrix.name }})
9779
needs: validate
@@ -206,17 +188,11 @@ jobs:
206188
done
207189
done
208190
209-
notes_file="release-assets/release-notes/release-notes.md"
210-
if [[ ! -s "${notes_file}" ]]; then
211-
echo "Missing release notes artifact: ${notes_file}" >&2
212-
exit 1
213-
fi
214-
215191
gh release create "${version}" \
216192
--repo "${GITHUB_REPOSITORY}" \
217193
--target "${target}" \
218194
--title "${version}" \
219-
--notes-file "${notes_file}" \
195+
--generate-notes \
220196
--draft
221197
gh release upload "${version}" "${asset_paths[@]}" --repo "${GITHUB_REPOSITORY}"
222198

CHANGELOG.md

Lines changed: 0 additions & 10 deletions
This file was deleted.

docs/release.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,6 @@ release is published without the required assets, do not mutate or reuse that
1717
tag; cut the next version instead.
1818

1919
## Prep
20-
- Update `CHANGELOG.md` with release notes and date.
21-
The release workflow extracts notes from a `## vX.Y.Z - YYYY-MM-DD` section.
2220
- Bump versions in `Cargo.toml` (workspace and crates) as needed.
2321
- Ensure `Cargo.lock` is updated and committed.
2422
- Confirm vendor/picoquic is at the intended commit and submodules are initialized.
@@ -73,9 +71,10 @@ Use the exact commit SHA that passed validation. Do not create or push a local
7371
Git tag first for this workflow.
7472

7573
The workflow builds all six binary artifacts, creates a draft release, uploads
76-
the required assets, and verifies the draft asset list. Leave `publish=false`
77-
to inspect the draft before publication. Use `publish=true` only when the
78-
release should be published immediately after the asset check. Release
74+
the required assets, verifies the draft asset list, and asks GitHub to generate
75+
release notes. Leave `publish=false` to inspect the draft before publication.
76+
Use `publish=true` only when the release should be published immediately after
77+
the asset check. Release
7978
immutability locks the tag and assets after publication, so a missing asset
8079
after publication means the release is bad and the fix is a new version.
8180

0 commit comments

Comments
 (0)