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: RELEASE.md
+19-2
Original file line number
Diff line number
Diff line change
@@ -68,12 +68,29 @@ to open them up to the larger community. The release team also meets ad-hoc as n
68
68
69
69
# Release notes
70
70
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
72
88
73
89
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.
74
90
75
91
> example usage (be sure to run `cabal build all` at least once beforehand):
0 commit comments