Skip to content

Commit 402917b

Browse files
authored
Document moving major tags in README (#87)
## Summary - explain that major tags like are moving tags - recommend pinning to a specific release tag or commit SHA for stable references ## Testing - not run (documentation only)
1 parent fbfa077 commit 402917b

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,12 @@ jobs:
2222
prek run --show-diff-on-failure --color=always <extra-args>
2323
```
2424

25+
## Version Tags
26+
27+
The major tag, such as `v1`, is a moving tag. It is updated to point to the latest `v1.x.y` release.
28+
29+
If you want a stable reference, do not pin to `v1`. Instead, pin to a specific release tag such as `v1.1.1`, or pin to a commit SHA.
30+
2531
## Inputs
2632

2733
| Input | Description | Required | Default |

0 commit comments

Comments
 (0)