Skip to content

Commit 02b4b46

Browse files
pankgeorgclaude
andcommitted
docs: remove duplicate releaserc, fix phantom no-commit references
.releaserc.with-commit.json was byte-identical to .releaserc.json, and both docs described a mode switch via a .releaserc.no-commit.json that never existed. Mode switching is now documented as adding/removing the @semantic-release/git plugin block. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent 70512e4 commit 02b4b46

2 files changed

Lines changed: 14 additions & 46 deletions

File tree

docs/RELEASE_WORKFLOW.md

Lines changed: 9 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Release Workflow
22

3-
This project uses semantic-release in **with-commit mode** to handle releases: the active `.releaserc.json` includes `@semantic-release/git`, so version bumps and CHANGELOG updates are committed back to `main` automatically. (`.releaserc.with-commit.json` is a historical copy of the same mode; the no-commit description this document previously carried no longer matches the configuration.)
3+
This project uses semantic-release in **with-commit mode** to handle releases: `.releaserc.json` includes `@semantic-release/git`, so version bumps and CHANGELOG updates are committed back to `main` automatically.
44

55
## How It Works
66

@@ -106,25 +106,12 @@ This will:
106106
- Show what files would be included
107107
- Not create any release or tag
108108

109-
## Switching to With-Commit Mode
109+
## Switching to No-Commit Mode
110110

111-
If you later want semantic-release to automatically update versions:
112-
113-
```bash
114-
# Switch configs
115-
mv .releaserc.json .releaserc.no-commit.json
116-
mv .releaserc.with-commit.json .releaserc.json
117-
118-
# Update workflow
119-
# Edit .github/workflows/release.yml:
120-
# - Add GH_PAT token configuration
121-
# - Add git committer environment variables
122-
123-
# Commit
124-
git add .releaserc.json .releaserc.with-commit.json .github/workflows/release.yml
125-
git commit -m "chore: switch to semantic-release with commits"
126-
git push
127-
```
111+
To release without pushing version commits back to `main` (e.g. while the
112+
`GH_PAT` ruleset bypass is unavailable), remove the `@semantic-release/git`
113+
plugin block from `.releaserc.json` and commit that change. Versions in
114+
`package.json` and `CHANGELOG.md` must then be maintained manually.
128115

129116
See `docs/RULESETS_QUICK_FIX.md` for setting up PAT bypass with GitHub Rulesets.
130117

@@ -145,11 +132,10 @@ Before each release:
145132

146133
## Files Involved
147134

148-
- `.releaserc.json` - Current config (no-commit mode)
149-
- `.releaserc.with-commit.json` - Alternative config (with commits)
135+
- `.releaserc.json` - Current config (with-commit mode)
150136
- `.github/workflows/release.yml` - Release workflow
151-
- `package.json` - Version number (manual updates)
152-
- `CHANGELOG.md` - Release notes (manual updates)
137+
- `package.json` - Version number (updated by semantic-release)
138+
- `CHANGELOG.md` - Release notes (updated by semantic-release)
153139

154140
## Troubleshooting
155141

docs/RULESETS_QUICK_FIX.md

Lines changed: 5 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -101,22 +101,9 @@ Check the logs. If dry-run succeeds, uncheck "Dry run" and run again for real re
101101

102102
## Alternative: Release Without Pushing Commits
103103

104-
If you don't want to manage rulesets bypass, use the no-commit configuration:
105-
106-
### Quick Switch to No-Commit Mode
107-
108-
```bash
109-
# Rename current config
110-
mv .releaserc.json .releaserc.with-commit.json
111-
112-
# Use no-commit config
113-
mv .releaserc.no-commit.json .releaserc.json
114-
115-
# Commit the change
116-
git add .releaserc.json .releaserc.with-commit.json
117-
git commit -m "chore: use semantic-release without version commits"
118-
git push
119-
```
104+
If you don't want to manage rulesets bypass, switch to no-commit mode:
105+
remove the `@semantic-release/git` plugin block from `.releaserc.json` and
106+
commit that change.
120107

121108
This mode:
122109

@@ -130,13 +117,8 @@ You manage versions manually in this mode.
130117

131118
### Switch Back to With-Commit Mode
132119

133-
```bash
134-
mv .releaserc.json .releaserc.no-commit.json
135-
mv .releaserc.with-commit.json .releaserc.json
136-
git add .releaserc.json .releaserc.with-commit.json
137-
git commit -m "chore: restore semantic-release with version commits"
138-
git push
139-
```
120+
Restore the `@semantic-release/git` plugin block in `.releaserc.json`
121+
(see git history) and commit the change.
140122

141123
---
142124

0 commit comments

Comments
 (0)