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

Docs unclear about Github token permissions #739

Open
1 task done
aleclarson opened this issue Jul 1, 2024 · 2 comments
Open
1 task done

Docs unclear about Github token permissions #739

aleclarson opened this issue Jul 1, 2024 · 2 comments
Assignees
Labels
bug Something isn't working

Comments

@aleclarson
Copy link

Is there an existing issue for this?

  • I have searched the existing issues

Description of the bug

  1. Unclear which permissions are needed by the Github token.
  2. Unclear if the GITHUB_TOKEN provided by default in Github Actions is enough.

Steps To Reproduce

N/A

Expected behavior

Give clarity on the unanswered questions on this page: https://git-cliff.org/docs/integration/github#authentication

Screenshots / Logs

No response

Software information

N/A

Additional context

No response

@aleclarson aleclarson added the bug Something isn't working label Jul 1, 2024
Copy link

welcome bot commented Jul 1, 2024

Thanks for opening your first issue at git-cliff! Be sure to follow the issue template! ⛰️

@aleclarson
Copy link
Author

Ah okay I see it now, in the tip callout.

Follow this guide for creating an access token. It can be either a classic or fine-grained token without permissions.

I would suggest making it stand out more. Perhaps by giving it its own little sub-section in the Authentication section.

And this question is still unanswered:

Unclear if the GITHUB_TOKEN provided by default in Github Actions is enough.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants