Skip to content

Commit d1f6aec

Browse files
authored
Merge pull request #114 from datum-cloud/release-please
2 parents f51b5be + ba9e423 commit d1f6aec

File tree

4 files changed

+86
-0
lines changed

4 files changed

+86
-0
lines changed
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Release Please
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
workflow_dispatch:
8+
9+
permissions:
10+
contents: write
11+
pull-requests: write
12+
13+
jobs:
14+
release-please:
15+
runs-on: ubuntu-latest
16+
steps:
17+
- uses: google-github-actions/release-please-action@v4
18+
id: release
19+
with:
20+
token: ${{ secrets.GITHUB_TOKEN }}
21+
config-file: .release-please-config.json
22+
manifest-file: .release-please-manifest.json

.release-please-config.json

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"packages": {
3+
".": {
4+
"release-type": "node",
5+
"package-name": "datum.net",
6+
"changelog-path": "CHANGELOG.md",
7+
"bump-minor-pre-major": true,
8+
"bump-patch-for-minor-pre-major": true,
9+
"draft": false,
10+
"prerelease": false
11+
}
12+
},
13+
"$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"
14+
}

.release-please-manifest.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"datum.net": "0.0.0"
3+
}

README.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -189,6 +189,53 @@ The setup uses a multi-stage Dockerfile:
189189

190190
We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
191191

192+
## Version Management
193+
194+
This project uses [Release Please](https://github.com/googleapis/release-please) for automated version management. To bump the version, follow these commit message conventions:
195+
196+
### Version Bump Types
197+
198+
1. **Patch Version (0.0.x)** - For bug fixes:
199+
200+
```bash
201+
git commit -m "fix: resolve bug in search functionality"
202+
```
203+
204+
2. **Minor Version (0.x.0)** - For new features:
205+
206+
```bash
207+
git commit -m "feat: add new search feature"
208+
```
209+
210+
3. **Major Version (x.0.0)** - For breaking changes:
211+
212+
```bash
213+
git commit -m "feat!: completely redesign the UI"
214+
# or
215+
git commit -m "feat: new API design
216+
217+
BREAKING CHANGE: This changes the entire API structure"
218+
```
219+
220+
### Other Commit Types
221+
222+
These types don't trigger version bumps but are included in the changelog:
223+
224+
```bash
225+
git commit -m "docs: update README"
226+
git commit -m "chore: update dependencies"
227+
git commit -m "style: format code"
228+
git commit -m "refactor: restructure components"
229+
```
230+
231+
After pushing commits to the main branch:
232+
233+
1. Release Please will create a PR with the version bump
234+
2. The PR will include updated:
235+
- `package.json` version
236+
- `CHANGELOG.md`
237+
3. When the PR is merged, it will create a new release
238+
192239
## 🧞 Commands
193240

194241
All commands are run from the root of the project, from a terminal:

0 commit comments

Comments
 (0)