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

ci: extract changelog for GitHub release notes #92

Merged
merged 1 commit into from
Aug 30, 2023

Conversation

Conaclos
Copy link
Member

Summary

This PR updates the release workflows.
GitHub Release notes are now generated from the changelog.
The script extract the first subsection that starts with a digit, e.g. ## 1.1.0. This allows to skip ## Unreleased.

The changelog should be updated before every release.

I also removed useless fetch-depth parameter that is set to 1 by default.

Test Plan

Next release.

@Conaclos Conaclos temporarily deployed to Website deployment August 30, 2023 11:50 — with GitHub Actions Inactive
@Conaclos Conaclos requested a review from ematipico August 30, 2023 11:50
@ematipico
Copy link
Member

Next release.

Isn't there another way to test it? Even locally, to show us what the script will generate

Copy link
Member

@ematipico ematipico left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's best to create a bash script somewhere in the repository, maybe under a scripts/ folder. So we have one script used by all the workflows. If there's a bug, we would need to fix all the workflows and we might forget

@Conaclos Conaclos force-pushed the conaclos/release/extract-changelog branch from 679f042 to 23f82c6 Compare August 30, 2023 14:12
@Conaclos Conaclos temporarily deployed to Website deployment August 30, 2023 14:12 — with GitHub Actions Inactive
@Conaclos Conaclos requested a review from ematipico August 30, 2023 14:12
@Conaclos Conaclos force-pushed the conaclos/release/extract-changelog branch from 23f82c6 to 02804da Compare August 30, 2023 14:14
@Conaclos Conaclos temporarily deployed to Website deployment August 30, 2023 14:14 — with GitHub Actions Inactive
@Conaclos Conaclos force-pushed the conaclos/release/extract-changelog branch from 02804da to 0c9c533 Compare August 30, 2023 14:59
@Conaclos Conaclos temporarily deployed to Website deployment August 30, 2023 14:59 — with GitHub Actions Inactive
@Conaclos
Copy link
Member Author

I improved the script by using the Unreleased section if a section for the released version is not found. This allows supporting nightly releases.

Isn't there another way to test it? Even locally, to show us what the script will generate

I tested the script locally. However, there is no way to easily test the workflow...

@ematipico
Copy link
Member

Even a local test is enough :)

@Conaclos Conaclos force-pushed the conaclos/release/extract-changelog branch from 0c9c533 to 29a5705 Compare August 30, 2023 18:01
@Conaclos Conaclos temporarily deployed to Website deployment August 30, 2023 18:01 — with GitHub Actions Inactive
@Conaclos Conaclos merged commit 2c8343c into main Aug 30, 2023
@Conaclos Conaclos deleted the conaclos/release/extract-changelog branch August 30, 2023 18:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants