Skip to content

🩹 [Patch]: Update README to clarify GITHUB_TOKEN usage #77

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

Merged
Marius Storhaug (MariusStorhaug) merged 2 commits into from
Mar 7, 2025
Merged

🩹 [Patch]: Update README to clarify GITHUB_TOKEN usage #77

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
702807b
🩹 [Patch]: Update README to clarify GITHUB_TOKEN usage and improve fo…
MariusStorhaug Mar 7, 2025
06c2a1a
Update README.md
MariusStorhaug Mar 7, 2025
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

Automatically creates releases based on pull requests and labels.


## Specifications and practices

Auto-Release follows:
Expand Down Expand Up @@ -31,6 +32,7 @@ When a pull request is closed, the action will create a release based on the lab
> The labels can be configured using the `MajorLabels`, `MinorLabels` and `PatchLabels` parameters/settings in the configuration file to trigger
> on other labels.

This action is built on [GitHub-Script](https://github.com/PSModule/GitHub-Script) which by default uses the `GITHUB_TOKEN`.
## Usage

The action can be configured using the following settings:
Expand Down Expand Up @@ -100,8 +102,6 @@ jobs:

- name: Auto-Release
uses: PSModule/Auto-Release@v1
env:
GITHUB_TOKEN: ${{ github.token }} # Used for GitHub CLI authentication
```

## Permissions
Expand Down