chore: FXC-4066-improve-changelog-management#3292
Conversation
01a0f79 to
e1c9d2b
Compare
Diff CoverageDiff: origin/develop...HEAD, staged and unstaged changesNo lines with coverage information in this diff. |
yaugenst-flex
left a comment
There was a problem hiding this comment.
Thanks for setting up Towncrier-based changelog generation and automation. I found one actionable edge case in scripts/changelog_refs.py: if a release version is provided with a leading v, the script currently generates malformed compare links (...vvX.Y.Z). Please normalize new_version to strip a leading v before building reference links, and add a small regression check for this CLI input form.
42c8760 to
7295144
Compare
7295144 to
ef36082
Compare
0424669 to
f002567
Compare
f002567 to
e4607cb
Compare
daquinteroflex
left a comment
There was a problem hiding this comment.
Looks good thanks!
e4607cb to
8442c4c
Compare
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.
…s-and-make-better-changelogs Co-authored-by: yaugenst-flex <yannick@flexcompute.com>
8442c4c to
cccfca1
Compare
Summary
This PR migrates release-note management from manual
CHANGELOG.mdedits to Towncrier fragments and adds automation to generate changelog PRs for releases.Changes
towncrierin dev dependencies (pyproject.toml,poetry.lock)[tool.towncrier]config inpyproject.tomlchangelog.d/template.mdchangelog.d/README.mdchangelog.d/*.md.CHANGELOG.mdto Towncrier-managed format with start marker:<!-- towncrier release notes start -->scripts/changelog_refs.pyto update release compare links automatically.public/tidy3d/python-client-build-changelog-prto:CHANGELOG.mdfrom fragmentschore/build-changelog-*.github/workflows/README.mddocs/development/release/flow.rstdocs/development/release/version.rstAGENTS.mdDemo
Here is one demo run of the github action on a fork:
marcorudolphflex#4
Note
Medium Risk
Moderate risk due to new CI gating and release automation that can block merges or generate incorrect changelog/compare links if the workflow or reference updater misbehaves.
Overview
Migrates release notes from direct
CHANGELOG.mdedits to Towncrier fragments inchangelog.d/, including a Towncrier template/config, contributor docs, and moving current unreleased entries into fragment files;CHANGELOG.mdis reformatted as a generated file with a Towncrier marker.Adds automation for release managers: a new
public/tidy3d/python-client-build-changelog-prworkflow that builds the changelog from fragments, updates compare links via newscripts/changelog_refs.py(with tests), and opens an auto PR. CI is updated to block PRs that editCHANGELOG.mddirectly (except auto-generatedchore/build-changelog-*branches) and to exempt those branches from Jira-key branch-name enforcement; docs/agent guidelines and dev deps (towncrier) are updated accordingly.Written by Cursor Bugbot for commit cccfca1. This will update automatically on new commits. Configure here.