Skip to content

Commit 127b5d3

Browse files
committed
ci: release-please config and manifest #957
1 parent 73bd6aa commit 127b5d3

File tree

3 files changed

+84
-0
lines changed

3 files changed

+84
-0
lines changed

.release-please-manifest.json

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
".": "0.0.0"
3+
}

CONTRIBUTING.md

+19
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ Check out the [Roadmap](https://docs.atomicdata.dev/roadmap.html) if you want to
3030
- [Criterion benchmarks](#criterion-benchmarks)
3131
- [Drill](#drill)
3232
- [Responsible disclosure / Coordinated Vulnerability Disclosure](#responsible-disclosure--coordinated-vulnerability-disclosure)
33+
- [Automated releases and versioning](#automated-releases-and-versioning)
34+
- [Commits](#commits)
3335
- [Releases, Versioning and Tagging](#releases-versioning-and-tagging)
3436
- [CI situation](#ci-situation)
3537
- [Publishing manually - doing the CI's work](#publishing-manually---doing-the-cis-work)
@@ -196,6 +198,23 @@ If you encounter serious security risks, please refrain from posting these publi
196198
We could minimize the impact by first patching the issue, publishing the patch, and then (after 30 days) disclose the bug.
197199
So please first send an e-mail to [email protected] describing the issue, and then we will work on fixing it as soon as possible.
198200

201+
## Automated releases and versioning
202+
203+
We use `release-please` to automatically create version bumps and PRs.
204+
The `.release-please-manifest.json` file contains the configuration for this (see [docs](https://github.com/googleapis/release-please/blob/main/docs/manifest-releaser.md)).
205+
206+
## Commits
207+
208+
Use [ConventionalCommits](https://www.conventionalcommits.org/) for commit messages.
209+
210+
- `fix: ...` for bugfixes
211+
- `feat: ...` for new features
212+
- `chore: ...` for changes that don't affect the code (e.g. updating dependencies)
213+
214+
Be sure to link to issues using `#123`.
215+
216+
The Changelog is automatically updated!
217+
199218
## Releases, Versioning and Tagging
200219

201220
1. Commit changes

release-please-config.json

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
{
2+
"packages": {
3+
".": {
4+
"changelog-path": "CHANGELOG.md",
5+
"bump-minor-pre-major": false,
6+
"bump-patch-for-minor-pre-major": false,
7+
"draft": false,
8+
"prerelease": false
9+
},
10+
"browser/lib": {
11+
"release-type": "node",
12+
"component": "lib-js"
13+
},
14+
"browser/react": {
15+
"release-type": "node",
16+
"component": "react"
17+
},
18+
"browser/svelte": {
19+
"release-type": "node",
20+
"component": "svelte"
21+
},
22+
"browser/cli": {
23+
"release-type": "node",
24+
"component": "cli-js"
25+
},
26+
"server": {
27+
"release-type": "rust",
28+
"component": "server"
29+
},
30+
"lib": {
31+
"release-type": "rust",
32+
"component": "lib-rs"
33+
},
34+
"cli": {
35+
"release-type": "rust",
36+
"component": "cli-rs"
37+
}
38+
},
39+
"plugins": [
40+
{
41+
"type": "cargo-workspace",
42+
"merge": false
43+
},
44+
{
45+
"type": "node-workspace"
46+
},
47+
{
48+
"type": "linked-versions",
49+
"groupName": "atomic-linked-versions",
50+
"components": [
51+
"lib-js",
52+
"react",
53+
"svelte",
54+
"cli-js",
55+
"server",
56+
"lib-rs",
57+
"cli-rs"
58+
]
59+
}
60+
],
61+
"$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"
62+
}

0 commit comments

Comments
 (0)