Skip to content

Commit a8de5f9

Browse files
crisanlucidclaude
andcommitted
docs: extract Release Flow into ReleaseFlow.md, link from README
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 0fa63fc commit a8de5f9

2 files changed

Lines changed: 42 additions & 41 deletions

File tree

README.md

Lines changed: 1 addition & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -81,47 +81,7 @@ Pull requests are welcome :)
8181

8282
---
8383

84-
## Release Flow
85-
86-
Step-by-step guide for releasing a new version.
87-
88-
### 1. Develop on a feature branch
89-
90-
```bash
91-
git checkout -b feature/my-feature
92-
# ... make changes ...
93-
git add <files>
94-
git commit -m "feat: my feature"
95-
git push origin feature/my-feature
96-
```
97-
98-
### 2. Open a Pull Request → merge into `main`
99-
100-
Opening a PR triggers:
101-
- **Node.js CI** — installs deps, builds, runs tests
102-
- **CodeQL** — security scan
103-
104-
Merging into `main` additionally triggers:
105-
- **Build and Deploy** — deploys to GitHub Pages (only when source files change)
106-
107-
### 3. Bump the version
108-
109-
Go to **Actions → Bump version → Run workflow** and choose:
110-
- `patch` → bug fixes / small improvements (0.5.0 → 0.5.1)
111-
- `minor` → new features, backwards compatible (0.5.0 → 0.6.0)
112-
- `major` → breaking changes (0.5.0 → 1.0.0)
113-
114-
This workflow will:
115-
- Bump `package.json` + `package-lock.json` version
116-
- Create a git tag (e.g. `v0.6.0`) and push it
117-
- Open a PR named `chore: bump version to vX.X.X`
118-
119-
### 4. Merge the version bump PR
120-
121-
Merge the `chore: bump version to vX.X.X` PR into `main`. This automatically:
122-
- Runs CI (install, build, test)
123-
- Deploys to GitHub Pages
124-
- **Creates a GitHub Release** with auto-generated notes
84+
For the step-by-step release process see [ReleaseFlow.md](./ReleaseFlow.md).
12585

12686
---
12787

ReleaseFlow.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Release Flow
2+
3+
Step-by-step guide for releasing a new version.
4+
5+
### 1. Develop on a feature branch
6+
7+
```bash
8+
git checkout -b feature/my-feature
9+
# ... make changes ...
10+
git add <files>
11+
git commit -m "feat: my feature"
12+
git push origin feature/my-feature
13+
```
14+
15+
### 2. Open a Pull Request → merge into `main`
16+
17+
Opening a PR triggers:
18+
- **Node.js CI** — installs deps, builds, runs tests
19+
- **CodeQL** — security scan
20+
21+
Merging into `main` additionally triggers:
22+
- **Build and Deploy** — deploys to GitHub Pages (only when source files change)
23+
24+
### 3. Bump the version
25+
26+
Go to **Actions → Bump version → Run workflow** and choose:
27+
- `patch` → bug fixes / small improvements (0.5.0 → 0.5.1)
28+
- `minor` → new features, backwards compatible (0.5.0 → 0.6.0)
29+
- `major` → breaking changes (0.5.0 → 1.0.0)
30+
31+
This workflow will:
32+
- Bump `package.json` + `package-lock.json` version
33+
- Create a git tag (e.g. `v0.6.0`) and push it
34+
- Open a PR named `chore: bump version to vX.X.X`
35+
36+
### 4. Merge the version bump PR
37+
38+
Merge the `chore: bump version to vX.X.X` PR into `main`. This automatically:
39+
- Runs CI (install, build, test)
40+
- Deploys to GitHub Pages
41+
- **Creates a GitHub Release** with auto-generated notes

0 commit comments

Comments
 (0)