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

Add "xtask changelog ci" to validate CHANGELOG.md files #584

Merged
merged 7 commits into from
Sep 1, 2024

Conversation

exzachlyvv
Copy link
Collaborator

@exzachlyvv exzachlyvv commented Aug 9, 2024

End goal (bug): Create script to automate updating CHANGELOG.md

This task will be done in 2 parts:

  1. xtask changelog ci: validates all CHANGELOG.md files <-- this PR
  2. xtask changelog {major,minor,patch}: automatically updates changelogs with a new description.

@exzachlyvv exzachlyvv requested a review from ia0 as a code owner August 9, 2024 21:54
Copy link
Member

@ia0 ia0 left a comment

Choose a reason for hiding this comment

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

Thanks! I've created a dev/changelog branch for this work (making it the base branch). We can merge it at 2 different points in time:

  • Once when we have the CI check (e.g. xtask changelog ci).
  • Once when we have xtask changelog {major,minor,patch} commands.

crates/xtask/src/changelog.rs Outdated Show resolved Hide resolved
crates/xtask/src/changelog.rs Outdated Show resolved Hide resolved
crates/xtask/src/changelog.rs Outdated Show resolved Hide resolved
crates/xtask/src/changelog.rs Outdated Show resolved Hide resolved
crates/xtask/src/changelog.rs Outdated Show resolved Hide resolved
crates/xtask/src/changelog.rs Outdated Show resolved Hide resolved
crates/xtask/src/changelog.rs Outdated Show resolved Hide resolved
crates/xtask/src/changelog.rs Outdated Show resolved Hide resolved
crates/xtask/src/changelog.rs Show resolved Hide resolved
crates/xtask/src/main.rs Outdated Show resolved Hide resolved
@ia0 ia0 changed the base branch from main to dev/changelog August 10, 2024 10:43
@exzachlyvv
Copy link
Collaborator Author

Last part is still WIP - refactor string parsing to be stateful instead of rough sting manipulation.

@exzachlyvv exzachlyvv changed the title [WIP, DO NOT MERGE] Add "changelog" xtask script to automate updating CHANGELOG.md files. Add "xtask changelog ci" to validate CHANGELOG.md files Aug 26, 2024
@exzachlyvv
Copy link
Collaborator Author

This PR is ready for another pass. There is 1 validation missing: "The first version matches the Cargo.toml version." Will do that in follow up PR.

Copy link
Member

@ia0 ia0 left a comment

Choose a reason for hiding this comment

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

Thanks! Looks pretty good to me.

crates/api-macro/CHANGELOG.md Outdated Show resolved Hide resolved
crates/cli-tools/src/fs.rs Outdated Show resolved Hide resolved
crates/xtask/src/main.rs Outdated Show resolved Hide resolved
crates/xtask/src/main.rs Outdated Show resolved Hide resolved
crates/xtask/src/main.rs Outdated Show resolved Hide resolved
crates/xtask/src/changelog.rs Outdated Show resolved Hide resolved
crates/xtask/src/changelog.rs Outdated Show resolved Hide resolved
crates/xtask/src/changelog.rs Outdated Show resolved Hide resolved
crates/xtask/src/changelog.rs Outdated Show resolved Hide resolved
crates/xtask/src/changelog.rs Outdated Show resolved Hide resolved
@ia0 ia0 mentioned this pull request Aug 28, 2024
Copy link
Member

@ia0 ia0 left a comment

Choose a reason for hiding this comment

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

Thanks! I've updated the branch to master and added a small commit with nits. I didn't review the changelog.rs file. I'll do that in the follow-up PRs. Also, we should have a PR before then that moves the module from xtask to cli-tools.

@ia0 ia0 merged commit a328f9c into google:dev/changelog Sep 1, 2024
20 checks passed
ia0 added a commit that referenced this pull request Oct 9, 2024
Diff will clean up after PR #584 is merged

---------

Co-authored-by: Julien Cretin <[email protected]>
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