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

Update README. #181

Merged
merged 3 commits into from
Sep 16, 2024
Merged

Update README. #181

merged 3 commits into from
Sep 16, 2024

Conversation

monochromegane
Copy link
Contributor

Thank you for providing such a useful tool.
When I was installing it, I found some parts of the README that needed updating, so I created a pull request.

permissions

The permissions given to the GITHUB_TOKEN for the job should be minimal.
In some articles, they choose the “Read and write permissions” button in the “Workflow permissions” section under “Settings > Actions > General”.
However, we can use permissions to modify the default permissions granted to the GITHUB_TOKEN.
ref: https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#permissions

Additional setting

After setting permissions, there is one more setting required to run tagpr.
For this reason, I propose adding this setting to the README.

Here is final minimum setting for running tagpr:
image

actions/checkout

To prevent the following warning, I propose using newer version.
The following actions use a deprecated Node.js version and will be forced to run on node20: actions/checkout@v3.

@Songmu Songmu merged commit a667113 into Songmu:main Sep 16, 2024
3 checks passed
@Songmu
Copy link
Owner

Songmu commented Sep 16, 2024

Thank you!

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.

2 participants