Skip to content

Commit

Permalink
feat: release-please cleanup
Browse files Browse the repository at this point in the history
Stop forcing the initial version to 0.1.0, to allow for release-please
version updates. Also, automate the update of the README on release.

Closes cloudnative-pg#114

Signed-off-by: Francesco Canovai <[email protected]>
  • Loading branch information
fcanovai authored and leonardoce committed Dec 17, 2024
1 parent aa45512 commit 2f8c856
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 4 deletions.
3 changes: 0 additions & 3 deletions .github/workflows/release-please.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,6 @@ jobs:
path: ./manifest.yaml
# TODO: remove bump-minor-pre-major when in production. It prevents
# release-please from bumping the major version on breaking changes.
# TODO: remove release-as after first release. Used to set the first
# release version, which would default to 1.0.0. Set the version
# manually also for 1.0.0.
# We use a GitHub token with write permissions to create the release,
# otherwise we won't be able to trigger a new run when pushing on main.
- name: Run release-please
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,10 +105,12 @@ Both checks are necessary to proceed with the installation.

Use `kubectl` to apply the manifest for the latest commit in the `main` branch:

<!-- x-release-please-start-version -->
```sh
kubectl apply -f \
https://github.com/cloudnative-pg/plugin-barman-cloud/releases/download/v0.1.0/manifest.yaml
```
<!-- x-release-please-end -->

Example output:

Expand Down
4 changes: 3 additions & 1 deletion release-please-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@
"bump-minor-pre-major": true,
"bump-patch-for-minor-pre-major": false,
"draft": false,
"extra-files": [
"README.md"
],
"prerelease": false,
"packages": {
".": {}
},
"plugins": [ "sentence-case" ],
"release-as": "0.1.0",
"signoff": "Peggie <[email protected]>",
"$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"
}

0 comments on commit 2f8c856

Please sign in to comment.