Skip to content

Commit 15e5c40

Browse files
🩹 [Patch]: Update README to clarify GITHUB_TOKEN usage (#77)
## Description This pull request includes updates to the `README.md` file to improve documentation and remove redundant environment variables. Documentation updates: * Added a note about the action being built on `GitHub-Script` and its default use of the `GITHUB_TOKEN`. ## Type of change <!-- Use the check-boxes [x] on the options that are relevant. --> - [x] 📖 [Docs] - [ ] 🪲 [Fix] - [x] 🩹 [Patch] - [ ] ⚠️ [Security fix] - [ ] 🚀 [Feature] - [ ] 🌟 [Breaking change] ## Checklist <!-- Use the check-boxes [x] on the options that are relevant. --> - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas --------- Co-authored-by: Copilot <[email protected]>
1 parent 6e55e2d commit 15e5c40

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
Automatically creates releases based on pull requests and labels.
44

5+
56
## Specifications and practices
67

78
Auto-Release follows:
@@ -31,6 +32,7 @@ When a pull request is closed, the action will create a release based on the lab
3132
> The labels can be configured using the `MajorLabels`, `MinorLabels` and `PatchLabels` parameters/settings in the configuration file to trigger
3233
> on other labels.
3334
35+
This action is built on [GitHub-Script](https://github.com/PSModule/GitHub-Script) which by default uses the `GITHUB_TOKEN`.
3436
## Usage
3537

3638
The action can be configured using the following settings:
@@ -100,8 +102,6 @@ jobs:
100102

101103
- name: Auto-Release
102104
uses: PSModule/Auto-Release@v1
103-
env:
104-
GITHUB_TOKEN: ${{ github.token }} # Used for GitHub CLI authentication
105105
```
106106
107107
## Permissions

0 commit comments

Comments
 (0)