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.

Sign up for GitHub

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

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2d01b82
Use permissions to modify the default permissions granted to the GITH…
monochromegane Sep 16, 2024
ddf00fb
Use a newer version of the checkout action.
monochromegane Sep 16, 2024
ab51e13
Add the necessary settings to the README.
monochromegane Sep 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,18 @@ on:
jobs:
tagpr:
runs-on: ubuntu-latest
permissions:
contents: write
pull-requests: write
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- uses: Songmu/tagpr@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```

To enable pull requests to be created through GitHub Actions, check the "Allow GitHub Actions to create and approve pull requests" box in the "Workflow permissions" section under "Settings > Actions > General" in the repository where you are installing `tagpr`.

If you do not want to use the token provided by GitHub Actions, do the following This is useful if you want to trigger another action with a tag.

ref. <https://docs.github.com/en/actions/security-guides/automatic-token-authentication#using-the-github_token-in-a-workflow>
Expand All @@ -47,7 +52,7 @@ jobs:
tagpr:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
with:
token: ${{ secrets.GH_PAT }}
- uses: Songmu/tagpr@v1
Expand Down Expand Up @@ -147,7 +152,7 @@ The tagpr produces output to be used in conjunction with subsequent GitHub Actio
It is useful to see if tag is available and to run tasks after release. The following is an example of running action-update-semver after release.

```yaml
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- id: tagpr
uses: Songmu/tagpr@v1
env:
Expand Down
Loading