Skip to content

Commit 1ad9278

Browse files
committed
Trim versioning section in CLAUDE.md to repo-specific essentials
https://claude.ai/code/session_015h9iYcSULNLdxvk8aZ8v3g
1 parent 13f43eb commit 1ad9278

File tree

1 file changed

+5
-27
lines changed

1 file changed

+5
-27
lines changed

CLAUDE.md

Lines changed: 5 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -67,38 +67,16 @@ not just this one. Every change we make must account for the experience of those
6767

6868
## Versioning & Releases
6969

70-
We follow the standard GitHub Actions versioning convention using semantic versioning tags
71-
alongside floating major tags.
70+
We use semver tags (`v1.0.0`) alongside a floating major tag (`v1`) — consumers pin to `@v1`.
71+
Only bump the major version for breaking changes (e.g. removed/renamed inputs, new required secrets).
7272

73-
- **Semantic tags** (`v1.0.0`, `v1.2.3`) are immutable and mark exact releases.
74-
- **Floating major tags** (`v1`, `v2`) always point to the latest non-breaking release
75-
in that major line. Consumers use `uses: DeDuckProject/git-glimpse@v1` to stay on the
76-
latest compatible version.
77-
- Only cut `v2` (bump the major version) for **breaking changes**.
78-
79-
### What counts as a breaking change
80-
81-
- Removing or renaming an existing action input or output
82-
- Changing the default behavior of an existing input in a way that alters results
83-
- Requiring a new permission, secret, or workflow event that consumers must add
84-
- Dropping support for a previously supported runner OS or Node version
85-
86-
### How to release
73+
To release:
8774

8875
```bash
89-
./scripts/release.sh <version> # e.g. ./scripts/release.sh 1.0.0
76+
./scripts/release.sh 1.0.0
9077
```
9178

92-
The script will:
93-
1. Create the immutable tag `v<version>`
94-
2. Force-move the floating major tag (`v1`, `v2`, etc.) to the same commit
95-
3. Push both tags to origin
96-
97-
A GitHub Actions workflow (`.github/workflows/release.yml`) automatically creates a
98-
GitHub Release with auto-generated release notes when a `v*.*.*` tag is pushed.
99-
100-
**Important:** Never push a release without updating both the semantic and floating tags.
101-
The release script handles this automatically — always use it instead of manual tagging.
79+
Always use the script — it handles both tags atomically. Never tag manually.
10280

10381
## Branching Convention
10482

0 commit comments

Comments
 (0)