Skip to content

Commit

Permalink
Implement versioning ADR (#321)
Browse files Browse the repository at this point in the history
* update renovate

* add release workflow

* document versioning

---------

Co-authored-by: joshmeranda <joshua.meranda@gmail.com>
  • Loading branch information
joshmeranda and joshmeranda authored Nov 15, 2024
1 parent ea17719 commit 61e80cf
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/renovate.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"github>rancher/renovate-config#release"
],
"baseBranches": [
"main"
"main", "release/v0.4", "release/v0.3", "release/v0.2", "release/v0.1"
],
"prHourlyLimit": 2
}
21 changes: 21 additions & 0 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Release

on:
push:
tags:
- v*

jobs:
release:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name : Checkout repository
uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7

- name: Create release on Github
run: |
gh --repo "${{ github.repository }}" release create ${{ github.ref_name }} --verify-tag --generate-notes
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -813,3 +813,8 @@ Before running the tests, you must run the following command to setup the fake s
# current client-go version, as seen in scripts/test.sh
export KUBEBUILDER_ASSETS=$(setup-envtest use -p path)
```
# Versioning
See [VERSION.md](VERSION.md).
9 changes: 9 additions & 0 deletions VERSION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Steve follows a pre-release (v0.x) strategy of semver. There is no compatibility between releases, and new releases are meant to be strictly compatible with a single version of Rancher. The current supported versions of Steve are as follows:

| Steve Branch | Steve Minor version | Matching Rancher Version |
|--------------------------|------------------------------------|------------------------------------------------|
| main | v0.5 | v2.11 |
| release/v0.4 | v0.4 | v2.10 |
| release/v0.3 | v0.3 | v2.9 |
| release/v0.2 | v0.2 | v2.8 |
| release/v0.1 | v0.1 | v2.7 |

0 comments on commit 61e80cf

Please sign in to comment.