|
| 1 | +# Releasing Rancher Turtles against `rancher/charts` and `rancher/rancher` repositories. |
| 2 | + |
| 3 | +## Important |
| 4 | +Before running the workflows, always run the `rancher/charts` workflow first and merge its PR. |
| 5 | +Only after the chart Pull Request is merged should you run the `rancher/rancher` workflow. |
| 6 | + |
| 7 | +> Following this order ensures the new Rancher Turtles version exists in charts and prevents broken CI in Rancher. |
| 8 | +
|
| 9 | +--- |
| 10 | + |
| 11 | +## GitHub workflows |
| 12 | + |
| 13 | +This repository provides GitHub Actions to automate bumping Rancher Turtles versions in `rancher/charts` and `rancher/rancher` repositories. |
| 14 | +These workflows are located in the [.github/workflows](https://github.com/rancher/turtles/tree/main/.github/workflows) directory and include: |
| 15 | + |
| 16 | +- `release-against-charts.yml` – updates the `rancher-turtles` chart in `rancher/charts`. |
| 17 | +- `release-against-rancher.yml` – updates the embedded Turtles version in `rancher/rancher`. |
| 18 | + |
| 19 | +Both workflows are **manual** and run from the [Actions tab](https://github.com/rancher/turtles/actions). |
| 20 | + |
| 21 | +--- |
| 22 | + |
| 23 | +### Release Rancher Turtles against `rancher/charts` |
| 24 | + |
| 25 | +This workflow creates a pull request in [rancher/charts](https://github.com/rancher/charts) repository to bump the Rancher Turtles version. |
| 26 | + |
| 27 | +> **Note:** Once the GitHub workflow completes successfully, it automatically opens a pull request in the `rancher/charts` repository. |
| 28 | +
|
| 29 | +```yaml |
| 30 | +Inputs: |
| 31 | +charts_ref – Target branch in rancher/charts (e.g. dev-v2.12). |
| 32 | +prev_turtles – Previous Rancher Turtles version (e.g. v0.23.0-rc.0). |
| 33 | +new_turtles – New Rancher Turtles version (e.g. v0.23.0). |
| 34 | +bump_major – Whether to bump the chart’s major version when Turtles’ minor version increases (true/false). |
| 35 | +``` |
| 36 | + |
| 37 | +**Example:** To release `v0.24.0` after `v0.24.0-rc.0` into the `dev-v2.12` branch of `rancher/charts`, run the workflow with the following inputs: |
| 38 | + |
| 39 | +```yaml |
| 40 | +charts_ref: dev-v2.12 |
| 41 | +prev_turtles: v0.24.0-rc.0 |
| 42 | +new_turtles: v0.24.0 |
| 43 | +bump_major: false |
| 44 | +``` |
| 45 | +
|
| 46 | +### Release Rancher Turtles against `rancher/rancher` |
| 47 | + |
| 48 | +This workflow creates a pull request in [rancher/rancher](https://github.com/rancher/rancher) repository to bump the Rancher Turtles version. |
| 49 | + |
| 50 | +> **Note:** Once the GitHub workflow completes successfully, it automatically opens a pull request in the `rancher/rancher` repository. |
| 51 | + |
| 52 | +```yaml |
| 53 | +Inputs: |
| 54 | +rancher_ref – Target branch in rancher/rancher (e.g. release/v2.12). |
| 55 | +prev_turtles – Previous Rancher Turtles version. |
| 56 | +new_turtles – New Rancher Turtles version. |
| 57 | +bump_major – Whether to bump the chart’s major version when Turtles’ minor version increases (true/false). |
| 58 | +``` |
| 59 | + |
| 60 | +**Example:** To update Rancher Turtles from `v0.23.0` to `v0.24.0` in the `release/v2.12` branch of `rancher/rancher`, run the workflow with the following inputs: |
| 61 | + |
| 62 | +```yaml |
| 63 | +rancher_ref: release/v2.12 |
| 64 | +prev_turtles: v0.23.0 |
| 65 | +new_turtles: v0.24.0 |
| 66 | +bump_major: true |
| 67 | +``` |
| 68 | + |
| 69 | +### Release Flow |
| 70 | + |
| 71 | +```mermaid |
| 72 | +flowchart LR |
| 73 | + A[🚀 Rancher Turtles release] --> B[⚙️ Run `rancher/charts` workflow] |
| 74 | + B --> C[✅ Merge PR in `rancher/charts`] |
| 75 | + C --> D[⚙️ Run `rancher/rancher` workflow] |
| 76 | + D --> E[✅ Merge PR in `rancher/rancher`] |
0 commit comments