From 222907be5fdf54bf33e3b7b2ec82153434f71761 Mon Sep 17 00:00:00 2001 From: Joep Meindertsma Date: Mon, 9 Sep 2024 14:26:27 +0200 Subject: [PATCH 1/3] ci: release-please test --- .github/workflows/release_please.yml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .github/workflows/release_please.yml diff --git a/.github/workflows/release_please.yml b/.github/workflows/release_please.yml new file mode 100644 index 00000000..df8bb649 --- /dev/null +++ b/.github/workflows/release_please.yml @@ -0,0 +1,22 @@ +on: + push: + branches: + - main + - replease-please-test + +permissions: + contents: write + pull-requests: write + +name: release-please + +jobs: + release-please: + runs-on: ubuntu-latest + steps: + - uses: googleapis/release-please-action@v4 + with: + token: ${{ secrets.GITHUB_TOKEN }} + # this is a built-in strategy in release-please, see "Action Inputs" + # for more options + release-type: simple From 73bd6aac8ef23fa8a5f747f0149261083f6fb9dd Mon Sep 17 00:00:00 2001 From: Joep Meindertsma Date: Mon, 9 Sep 2024 14:39:36 +0200 Subject: [PATCH 2/3] Fix branch name --- .github/workflows/release_please.yml | 2 +- .github/workflows/release_plz.yml | 27 --------------------------- 2 files changed, 1 insertion(+), 28 deletions(-) delete mode 100644 .github/workflows/release_plz.yml diff --git a/.github/workflows/release_please.yml b/.github/workflows/release_please.yml index df8bb649..e54baf4b 100644 --- a/.github/workflows/release_please.yml +++ b/.github/workflows/release_please.yml @@ -2,7 +2,7 @@ on: push: branches: - main - - replease-please-test + - release-please-test permissions: contents: write diff --git a/.github/workflows/release_plz.yml b/.github/workflows/release_plz.yml deleted file mode 100644 index cc5bc4ff..00000000 --- a/.github/workflows/release_plz.yml +++ /dev/null @@ -1,27 +0,0 @@ -name: Release-plz - -permissions: - pull-requests: write - contents: write - -on: - push: - branches: - - main - -jobs: - release-plz: - name: Release-plz - runs-on: ubuntu-latest - steps: - - name: Checkout repository - uses: actions/checkout@v4 - with: - fetch-depth: 0 - - name: Install Rust toolchain - uses: dtolnay/rust-toolchain@stable - - name: Run release-plz - uses: MarcoIeni/release-plz-action@v0.5 - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }} From 127b5d3a2caf3d55394319d281625083fa7cd305 Mon Sep 17 00:00:00 2001 From: Joep Meindertsma Date: Mon, 9 Sep 2024 16:40:08 +0200 Subject: [PATCH 3/3] ci: release-please config and manifest #957 --- .release-please-manifest.json | 3 ++ CONTRIBUTING.md | 19 +++++++++++ release-please-config.json | 62 +++++++++++++++++++++++++++++++++++ 3 files changed, 84 insertions(+) create mode 100644 .release-please-manifest.json create mode 100644 release-please-config.json diff --git a/.release-please-manifest.json b/.release-please-manifest.json new file mode 100644 index 00000000..e18ee077 --- /dev/null +++ b/.release-please-manifest.json @@ -0,0 +1,3 @@ +{ + ".": "0.0.0" +} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 53fa3803..9f407078 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,6 +30,8 @@ Check out the [Roadmap](https://docs.atomicdata.dev/roadmap.html) if you want to - [Criterion benchmarks](#criterion-benchmarks) - [Drill](#drill) - [Responsible disclosure / Coordinated Vulnerability Disclosure](#responsible-disclosure--coordinated-vulnerability-disclosure) +- [Automated releases and versioning](#automated-releases-and-versioning) +- [Commits](#commits) - [Releases, Versioning and Tagging](#releases-versioning-and-tagging) - [CI situation](#ci-situation) - [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 We could minimize the impact by first patching the issue, publishing the patch, and then (after 30 days) disclose the bug. So please first send an e-mail to joep@ontola.io describing the issue, and then we will work on fixing it as soon as possible. +## Automated releases and versioning + +We use `release-please` to automatically create version bumps and PRs. +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)). + +## Commits + +Use [ConventionalCommits](https://www.conventionalcommits.org/) for commit messages. + +- `fix: ...` for bugfixes +- `feat: ...` for new features +- `chore: ...` for changes that don't affect the code (e.g. updating dependencies) + +Be sure to link to issues using `#123`. + +The Changelog is automatically updated! + ## Releases, Versioning and Tagging 1. Commit changes diff --git a/release-please-config.json b/release-please-config.json new file mode 100644 index 00000000..e039b69c --- /dev/null +++ b/release-please-config.json @@ -0,0 +1,62 @@ +{ + "packages": { + ".": { + "changelog-path": "CHANGELOG.md", + "bump-minor-pre-major": false, + "bump-patch-for-minor-pre-major": false, + "draft": false, + "prerelease": false + }, + "browser/lib": { + "release-type": "node", + "component": "lib-js" + }, + "browser/react": { + "release-type": "node", + "component": "react" + }, + "browser/svelte": { + "release-type": "node", + "component": "svelte" + }, + "browser/cli": { + "release-type": "node", + "component": "cli-js" + }, + "server": { + "release-type": "rust", + "component": "server" + }, + "lib": { + "release-type": "rust", + "component": "lib-rs" + }, + "cli": { + "release-type": "rust", + "component": "cli-rs" + } + }, + "plugins": [ + { + "type": "cargo-workspace", + "merge": false + }, + { + "type": "node-workspace" + }, + { + "type": "linked-versions", + "groupName": "atomic-linked-versions", + "components": [ + "lib-js", + "react", + "svelte", + "cli-js", + "server", + "lib-rs", + "cli-rs" + ] + } + ], + "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json" +}