Skip to content

fix: update README for clarity and versioning guidance #218

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
ChristophShyper merged 2 commits into from
May 22, 2026
Merged

fix: update README for clarity and versioning guidance #218

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
71c10d4
fix: update README for clarity and versioning guidance
ChristophShyper May 22, 2026
4878145
fix: add package write permission to auto-release workflow
ChristophShyper May 22, 2026
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
1 change: 1 addition & 0 deletions .github/workflows/auto-release-create.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ on:

permissions:
contents: write
packages: write
pull-requests: read

jobs:
Expand Down
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ permissions:
- `issues: write` is required when managed overflow comments are created, updated, or deleted (including cleanup on later runs).


### 📤 Outputs Parameters
### 📤 Output Parameters
| Output | Description |
|-------------|-------------------------------|
| `url` | Pull request URL |
Expand Down Expand Up @@ -211,7 +211,10 @@ jobs:
```

### 🎯 Use specific version
Run the Action with a specific version tag.
Pick the tag level based on your stability needs:
- `vX.Y.Z`: exact immutable release (most predictable)
- `vX.Y`: latest patch within one minor line
- `vX`: latest patch within one major line

```yaml
name: Run the Action
Expand Down
Loading