Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changelogs generation #1411

Merged
merged 26 commits into from
Dec 12, 2023
Merged

Changelogs generation #1411

merged 26 commits into from
Dec 12, 2023

Conversation

chevdor
Copy link
Contributor

@chevdor chevdor commented Sep 5, 2023

This PR introduces a script and some templates to use the prdoc involved in a release and build:

  • the changelog
  • a simple draft of audience documentation

Since the prdoc presence was enforced in the middle of the version 1.5.0, not all PRs did come with a prdoc file.
This PR creates all the missing prdoc files with some minimum content allowing to properly generate the changelog.
The generated content is not suitable for the audience documentation.

The audience documentation will be possible with the next version, when all PR come with a proper prdoc.

Assumptions

  • the prdoc files for release vX.Y.Z have been moved under prdoc/X.Y.Z
  • the changelog requires for now for the prdoc files to contain author + topic. Thos fields are optional.

The build script can be called as:

VERSION=X.Y.Z ./scripts/release/build-changelogs.sh

Related:

- a very simple version that can already be used locally
@chevdor chevdor added R0-silent Changes should not be mentioned in any release notes T11-documentation This PR/Issue is related to documentation. labels Sep 5, 2023
@chevdor chevdor marked this pull request as ready for review December 12, 2023 13:42
@chevdor chevdor requested review from a team as code owners December 12, 2023 13:42
@chevdor chevdor enabled auto-merge (squash) December 12, 2023 14:24
@chevdor chevdor merged commit 42a3afb into master Dec 12, 2023
117 of 118 checks passed
@chevdor chevdor deleted the wk-230905-prdoc-changelogs branch December 12, 2023 14:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
R0-silent Changes should not be mentioned in any release notes T11-documentation This PR/Issue is related to documentation.
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants