Skip to content

Commit 8b7e09d

Browse files
committed
feat: clarify upgrade behavior in README
1 parent 95a79f4 commit 8b7e09d

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,24 @@ jobs:
3737
token: ${{ secrets.GITHUB_TOKEN }}
3838
```
3939
40+
## Workflow Updates and Versioning
41+
42+
This workflow uses a reference to the branch (`@main`) rather than a specific version tag. This means:
43+
44+
- **Automatic Updates**: When the workflow code is updated in the `main` branch, all repositories referencing it will automatically use the latest version without requiring any changes in those repositories.
45+
- **Breaking Changes**: Be cautious when making changes to the workflow in the `main` branch, as they will immediately affect all dependent repositories. Test significant changes thoroughly before merging them into `main`.
46+
47+
### Recommendations for Stability
48+
49+
If you need more stability and control over updates, consider:
50+
1. Using version tags (e.g., `@v1`, `@v2`) instead of `@main`.
51+
2. Having repositories explicitly opt-in to new versions by updating their workflow reference.
52+
53+
For example, to use a specific version tag:
54+
```yaml
55+
uses: your-org/auto-comments/.github/workflows/pr-auto-comments.yml@v1
56+
```
57+
4058
## Configuration
4159

4260
### Required Inputs

0 commit comments

Comments
 (0)