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

[RFC] Use profile link of a contributor in the CHANGELOG #1081

Open
pedro-psb opened this issue Mar 22, 2024 · 0 comments
Open

[RFC] Use profile link of a contributor in the CHANGELOG #1081

pedro-psb opened this issue Mar 22, 2024 · 0 comments
Labels
good first issue Not a Bug Not a Problem, expected behavior RFC

Comments

@pedro-psb
Copy link
Member

Problem

The new release script introduced in #1078 generates a changelog without the link to the author github profile:

dependabot alert 21 about Django (on tests) (#1067). By Bruno Rocha.

Proposal

I want it to be rendered as:

dependabot alert 21 about Django (on tests) (#1067). By [Bruno Rocha](https://github.com/rochacbruno).

Additional Context

The reason the github link is not fetched is because git-changelog only uses information available in git (name and email) in the commit range to be released.

To fetch the github link, we could hit the github API:

  1. Fetch a list of users from latest release to the current one
  2. Map user-email: url
  3. Link git user.email with github url using that map

We may have to open a PR in git-changelog to support this. Possible approaches to present to the project:

  • add the GitHub API fetch inside git-changelog
  • make it possible to provide a map (user-email: url), which should be available internally the template.
    • This map could be a simple toml file
    • We should generate this file externally using the GH API.

Possibly, we could integrate that solution with fixing the update_contributors workflow, which is broken.

@pedro-psb pedro-psb added Not a Bug Not a Problem, expected behavior RFC good first issue labels Mar 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Not a Bug Not a Problem, expected behavior RFC
Projects
None yet
Development

No branches or pull requests

1 participant