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

feature/changelog #8

Merged
merged 8 commits into from
Oct 25, 2023
Merged

feature/changelog #8

merged 8 commits into from
Oct 25, 2023

Conversation

busticated
Copy link
Owner

@busticated busticated commented Oct 25, 2023

Description

Adds cargo xtask changelog task to view unpublished changes for all crates. Updates cargo xtask crate:add task to add CHANGELOG.md file and cargo xtask crate:release to update crate's changelog with relevant commit messages.

How to Test

  1. Clone and setup this branch locally (docs)
  2. Review the "How to format commits for changelogs" FAQ item
  3. Review available tasks: cargo xtask --help
  4. List unpublished changes: cargo xtask changelog
  5. Run a simulated release: cargo xtask crate:release --dry-run

Outcome

Docs should be clear and helpful, the changelog task should show an accurate list of unpublished changes, and the release task should include updates to CHANGELOG.md for each targeted crate. As of now, the changelog task should output:

:::: detect-newline-style
* add new version markers to changelog

:::: node-js-release-info
* add new version markers to changelog
* add integration test for .fetch_all()
* lintings

Related / Discussions

#4

Completeness

  • PR opened 🎉
  • Testing instructions have been provided
  • Development How-To's have been provided
  • Docs have been updated (cargo xtask doc)
  • Branch is rebased against target (typically main)

@busticated
Copy link
Owner Author

:shipit:

@busticated busticated merged commit b258b49 into main Oct 25, 2023
6 checks passed
@busticated busticated deleted the feature/changelog branch October 25, 2023 18:03
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.

1 participant