chore(tidy3d-client): build release notes from changelog#3365
Draft
marcorudolphflex wants to merge 1 commit into
Draft
chore(tidy3d-client): build release notes from changelog#3365marcorudolphflex wants to merge 1 commit into
marcorudolphflex wants to merge 1 commit into
Conversation
marcorudolphflex
changed the title
marcorudolphflex
force-pushed
the
marco/changelog-release-notes
branch
3 times, most recently
from
63bae80 to
f96b7d3
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Use the tagged
CHANGELOG.mdrelease section as the GitHub release body instead of GitHub autogenerated release notes.Why
The current release workflow on
lateststill lets GitHub infer the compare range and note content. That can publish duplicated or misleading notes when GitHub chooses the wrong baseline.This change makes the GitHub release page match the curated changelog content for the tagged release.
Behavior
CHANGELOG.mdas## What's ChangedValidation
python3 -m py_compile scripts/build_github_release_notes.pypython3 scripts/build_github_release_notes.py --tag v2.9.2 --output /tmp/tidy3d-latest-release-notes-test.md.github/workflows/tidy3d-python-client-release.yml