Skip to content

Commit authors in changelog#74

Merged
zachdaniel merged 6 commits intozachdaniel:masterfrom
TwistingTwists:commit-authors-inchangelog
Jun 5, 2025
Merged

Commit authors in changelog#74
zachdaniel merged 6 commits intozachdaniel:masterfrom
TwistingTwists:commit-authors-inchangelog

Conversation

@TwistingTwists
Copy link
Copy Markdown
Contributor

fix: #73

Contributor checklist

  • My commit messages follow the Conventional Commit Message Format
    For example: fix: Multiply by appropriate coefficient, or
    feat(Calculator): Correctly preserve history
    Any explanation or long form information in your commit message should be
    in a separate paragraph, separated by a blank line from the primary message
  • Bug fixes include regression tests
  • Features include unit/acceptance tests

@zachdaniel
Copy link
Copy Markdown
Owner

I think what we might want to do is add a configuration here that tells us to use the GitHub API to look up handles for each commit so we can properly build the @, and then if that configuration isn't set we include the author directly instead of computing a fake handle for them. Thoughts?

@TwistingTwists
Copy link
Copy Markdown
Contributor Author

@TwistingTwists
Copy link
Copy Markdown
Contributor Author

I don't assume people will hit rate limits with this API. but if they run this in CI, they might.

@TwistingTwists
Copy link
Copy Markdown
Contributor Author

set we include the author directly

you mean, directly mention just the git user.name of the user, right?

@zachdaniel
Copy link
Copy Markdown
Owner

Yeah, instead of deriving like an @username that may not exist.

@TwistingTwists
Copy link
Copy Markdown
Contributor Author

TwistingTwists commented Apr 1, 2025

Made changes.

  1. look by git user.email via github api
  2. fallback to name (without @)
  3. added caching using persistent term.

Comment thread lib/git_ops/github.ex Outdated
@zachdaniel
Copy link
Copy Markdown
Owner

@TwistingTwists Any updates on this? Would be great to have this in ❤️

@TwistingTwists
Copy link
Copy Markdown
Contributor Author

Ah dang. I almost forgot about it.

Will update this later this week

- since usernames are looked up per commit, cache is implemented via
  persistent_term
- removed persistent_term
- use github_username if possilbe
- otherwise fallback to name from 'email' or commit.
@TwistingTwists TwistingTwists force-pushed the commit-authors-inchangelog branch from 0c3e705 to e4a175e Compare June 5, 2025 02:21
@TwistingTwists
Copy link
Copy Markdown
Contributor Author

@zachdaniel ready for review. :)

@zachdaniel zachdaniel merged commit 42b6c72 into zachdaniel:master Jun 5, 2025
@zachdaniel
Copy link
Copy Markdown
Owner

🚀 Thank you for your contribution! 🚀

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.

create better release messages

2 participants