Skip to content

Commit 04b1d91

Browse files
fix: update README for clarity and versioning guidance
1 parent f118649 commit 04b1d91

1 file changed

Lines changed: 7 additions & 4 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ This action supports three tag levels for flexible versioning:
6666
| `github_token` | No | | For authenticated GitHub requests. |
6767

6868

69-
### πŸ“€ Outputs Parameters
69+
### πŸ“€ Output Parameters
7070
| Output | Description |
7171
|:---------|:-------------------------------------|
7272
| `foobar` | Echo of provided `foobar` input. |
@@ -75,7 +75,7 @@ This action supports three tag levels for flexible versioning:
7575

7676
## πŸ’» Usage Examples
7777

78-
### πŸ“ Basic
78+
### πŸ“ Basic Example
7979
Run the Action with defaults.
8080

8181
```yaml
@@ -90,7 +90,7 @@ jobs:
9090
- uses: devops-infra/template-action@v1
9191
```
9292
93-
### πŸ”€ Advanced
93+
### πŸ”€ Advanced Example
9494
Run the Action with set inputs.
9595
9696
```yaml
@@ -109,7 +109,10 @@ jobs:
109109
```
110110
111111
### 🎯 Use specific version
112-
Run the Action with a specific version tag.
112+
Pick the tag level based on your stability needs:
113+
- `vX.Y.Z`: exact immutable release (most predictable)
114+
- `vX.Y`: latest patch within one minor line
115+
- `vX`: latest patch within one major line
113116

114117
```yaml
115118
name: Run the Action on each commit

0 commit comments

Comments
Β (0)