Skip to content

Commit 9778a0e

Browse files
committed
RELEASE.md: sketch the release notes
1 parent 7e0cecd commit 9778a0e

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

RELEASE.md

+19-2
Original file line numberDiff line numberDiff line change
@@ -68,12 +68,29 @@ to open them up to the larger community. The release team also meets ad-hoc as n
6868

6969
# Release notes
7070

71-
# Detailed changelog table
71+
The release notes are drafted and published via the GitHub releases UI.
72+
Our current template contains the following sections.
73+
74+
- (no header) A very-high level summary of the release.
75+
For larger release, it may be best for the Cardano Head of Product to draft this summary instead of the release engineer, since they have more context.
76+
- Known Issues
77+
- Technical Specification (usually unchanged)
78+
- Links to `cardano-node` documentation
79+
It seems to be a judgement call whether each of these should specify the upstream version.
80+
- Changelogs
81+
- Summaries of the major dependencies' changelogs.
82+
These are written as a few sentences that an interested user and/or dev would find helpful.
83+
It may be best for the individual teams to draft these summaries instead of the release engineer, since they have more context.
84+
- Links to the individual changelog of each upstream package that IOG maintains.
85+
See the script explained below.
86+
87+
## Detailed changelog table
7288

7389
There's a script (`scripts/generate-release-changelog-links.hs`) that generates a table of changelogs for each of the package versions included in a given `cardano-node` release. The script takes a cabal-generated `plan.json` and a GitHub API access token, and outputs a large table which contains links to the `CHANGELOG.md` file (if one exists) for each of the package versions contained in the build plan.
7490

7591
> example usage (be sure to run `cabal build all` at least once beforehand):
7692
> ```
77-
> ./scripts/generate-release-changelog-links.hs ./dist-newstyle/cache/build.json $GITHUB_API_TOKEN
93+
> $ nix build .#project.x86_64-linux.plan-nix.json
94+
> $ ./scripts/generate-release-changelog-links.hs result-json $GITHUB_API_TOKEN
7895
> ```
7996
> for more information, including how to generate / retrieve a GitHub API token, use `./scripts/generate-release-changelog-links.hs --help`

0 commit comments

Comments
 (0)