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

Switch to unclog #1232

Merged
merged 3 commits into from
Jul 26, 2021
Merged

Switch to unclog #1232

merged 3 commits into from
Jul 26, 2021

Conversation

thanethomson
Copy link
Contributor

@thanethomson thanethomson commented Jul 25, 2021

Closes: #1046

Description

I've updated unclog to be able to automatically resolve crates' names to their folders, such that you can add a .changelog entry with the following command:

# The "-c ibc" part is important
unclog add -c ibc improvements 123-some-issue

When building the changelog (unclog build -u to build unreleased changes), the output will look something like the following:

## Unreleased

### IMPROVEMENTS

- [ibc](modules)
  - An example issue

Right now unclog has support for Rust projects exclusively in the way we currently use our repos to facilitate a reverse lookup of a crate's folder (in this case the modules folder) from its crate name.


For contributor use:

  • Updated the Unreleased section of CHANGELOG.md with the issue.
  • If applicable: Unit tests written, added test to CI.
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Updated relevant documentation (docs/) and code comments.
  • Re-reviewed Files changed in the Github PR explorer.

Copy link
Member

@adizere adizere left a comment

Choose a reason for hiding this comment

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

Thank you Thane, looking forward to trying this!

@adizere adizere merged commit 66ceac2 into master Jul 26, 2021
@adizere adizere deleted the thane/1046-unclog branch July 26, 2021 07:59
@romac romac mentioned this pull request Jul 26, 2021
5 tasks
hu55a1n1 pushed a commit to hu55a1n1/hermes that referenced this pull request Sep 13, 2022
* Initialize .changelog folder with CHANGELOG.md as history

Signed-off-by: Thane Thomson <[email protected]>

* Build changelog

Signed-off-by: Thane Thomson <[email protected]>

* Update contributing guidelines for changelog updates

Signed-off-by: Thane Thomson <[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.

Switch to unclog to parallelize changelog updates
2 participants