Tag releases
#31
by ppuzio - opened
AGENTS.md
CHANGED
|
@@ -147,6 +147,14 @@ Two rules about all of the above:
|
|
| 147 |
per-source `stats.json` files.
|
| 148 |
4. Prepend the release notes to `CHANGELOG.md` under a new `## vX.Y.Z (date)`
|
| 149 |
heading. History is append-only — never rewrite earlier releases.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 150 |
|
| 151 |
## Push to Hugging Face
|
| 152 |
|
|
|
|
| 147 |
per-source `stats.json` files.
|
| 148 |
4. Prepend the release notes to `CHANGELOG.md` under a new `## vX.Y.Z (date)`
|
| 149 |
heading. History is append-only — never rewrite earlier releases.
|
| 150 |
+
5. Tag the commit where the docs and the artifacts agree, and push the tag:
|
| 151 |
+
```bash
|
| 152 |
+
git tag -a vX.Y.Z <commit> -m "vX.Y.Z stable: <docs> documents / <tokens> tokens / <n> sources"
|
| 153 |
+
git push origin vX.Y.Z
|
| 154 |
+
```
|
| 155 |
+
A release with no tag can only be cited by hash, and every later doc fix
|
| 156 |
+
makes that hash a worse citation than the one before it — which is how
|
| 157 |
+
`v0.2.5` ended up cited three different ways. Tag it once and cite the tag.
|
| 158 |
|
| 159 |
## Push to Hugging Face
|
| 160 |
|