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

style: add make changelog_style for automatic changelog formatting #4532

Merged
merged 1 commit into from
Jan 28, 2025

Conversation

romanz
Copy link
Contributor

@romanz romanz commented Jan 23, 2025

Added also to make style.

[no changelog]

@romanz romanz self-assigned this Jan 23, 2025
Copy link

github-actions bot commented Jan 23, 2025

core UI changes device test click test persistence test
T2T1 Model T test(screens) main(screens) test(screens) main(screens) test(screens) main(screens)
T3B1 Safe 3 test(screens) main(screens) test(screens) main(screens) test(screens) main(screens)
T3T1 Safe 5 test(screens) main(screens) test(screens) main(screens) test(screens) main(screens)
All main(screens)

Makefile Outdated
./tools/generate-changelog.py --fix-style legacy/bootloader
./tools/generate-changelog.py --fix-style legacy/firmware
./tools/generate-changelog.py --fix-style legacy/intermediate_fw
./tools/generate-changelog.py --fix-style python
Copy link
Contributor

Choose a reason for hiding this comment

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

this is becoming rather fragile, instead embed this list into generate-changelog
and make it fail if someone tries to use a non-listed path, telling them to also add the thing they want to the known path list

(that way we have a single command for "changelog check" and "changelog style" and we enforce that every changelog used by someone will be added to that list)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sounds good, thanks for the suggestion!
WDYT about 0132526?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

(I've also added @mmilata, since he is the author of tools/generate-changelog.py)

@romanz romanz requested a review from mmilata January 26, 2025 13:43
@romanz romanz marked this pull request as ready for review January 26, 2025 14:03
@romanz romanz requested a review from matejcik January 26, 2025 14:04
tools/changelog.py Outdated Show resolved Hide resolved
Copy link
Member

@mmilata mmilata left a comment

Choose a reason for hiding this comment

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

Looking good, but also please update references to generate-changelog.py in docs/misc/changelog.md.

@romanz
Copy link
Contributor Author

romanz commented Jan 27, 2025

Looking good, but also please update references to generate-changelog.py in docs/misc/changelog.md.

Thanks!
Updated in dcb3b2a.

@romanz romanz force-pushed the romanz/changelog-style branch from dcb3b2a to c15837b Compare January 28, 2025 09:07
@romanz
Copy link
Contributor Author

romanz commented Jan 28, 2025

Squashed and rebased over main.

@romanz romanz merged commit 2aca680 into main Jan 28, 2025
94 checks passed
@romanz romanz deleted the romanz/changelog-style branch January 28, 2025 10:10
@romanz romanz linked an issue Jan 28, 2025 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Approved
Development

Successfully merging this pull request may close these issues.

generate-changelog.py: make sure each entry ends with a period
3 participants