diff --git a/.github/workflows/release-cron.yml b/.github/workflows/release-cron.yml index ddcd099..36bdac0 100644 --- a/.github/workflows/release-cron.yml +++ b/.github/workflows/release-cron.yml @@ -7,6 +7,7 @@ on: permissions: contents: write + statuses: write jobs: check: diff --git a/README.md b/README.md index e2f76c4..9901a0e 100644 --- a/README.md +++ b/README.md @@ -137,6 +137,14 @@ Dependabot PRs are merged automatically if they pass all required checks (tests ## Releases +### Automatic Weekly Releases + +The workflow [Release Cron](https://github.com/cloudfoundry/storage-cli/actions/workflows/release-cron.yml) builds an automatic release every Monday morning if there are changes on the `main` branch (e.g. version bumps). + +The workflow builds and tests storage-cli, runs the integration tests and creates a **draft release** that needs to be published manually. Note that only published storage-cli releases are picked up by [capi-release](https://github.com/cloudfoundry/capi-release). + +If this process works well, the idea is to switch the workflow from draft to published releases. + ### Manual Release Releases must be triggered manually by an approver. This can be done either via `GitHub Actions` (workflow dispatch) or through the `GitHub Releases` page using the **Draft a new release** option. The *Release Manual* workflow is responsible for creating and completing the release.