Skip to content

Commit

Permalink
chore: replace v.4 with v4
Browse files Browse the repository at this point in the history
  • Loading branch information
kdoroszko-splunk committed Sep 5, 2024
1 parent 30276a3 commit 5f9f6ec
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions runbooks/backporting-changes-to-older-version.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
`addonfactory-workflow-addon-release` is utilized by all supported TAs. While it is strongly recommended to use the latest minor version of the reusable action, not all TAs consistently follow this guideline. As a result, there are cases when crucial updates introduced in the latest reusable workflow version need to be backported to its older versions that are still in use.

This runbook shows a real example of backporting changes correlated to `ta-automation-k8s-manifests`. In the example:
- current version of `addonfactory-workflow-addon-release` is `v.4.17.0`
- current version of `addonfactory-workflow-addon-release` is `v4.17.0`
- there was a bug in `ta-automation-k8s-manifests` affecting all TAs
- there is a need to make a fix and release `v.4.17.1` containing fixed `ta-automation-k8s-manifests` version ([PR](https://github.com/splunk/addonfactory-workflow-addon-release/pull/329))
- there is need to backport it to `v.4.16` (the old version which is still in use by some TAs)
- the latest patch release of `v.4.16` is `v.4.16.14`
- there is a need to make a fix and release `v4.17.1` containing fixed `ta-automation-k8s-manifests` version ([PR](https://github.com/splunk/addonfactory-workflow-addon-release/pull/329))
- there is need to backport it to `v4.16` (the old version which is still in use by some TAs)
- the latest patch release of `v4.16` is `v4.16.14`
### Steps
- make release `v.4.17.1` with necessary changes
- make release `v4.17.1` with necessary changes
- fetch all existing tags from `addonfactory-workflow-addon-release`:
```
git checkout main
Expand All @@ -23,7 +23,7 @@ This runbook shows a real example of backporting changes correlated to `ta-autom
```
git checkout -b fix/bump-k8s-manifest-version
```
- changes made in `ta-automation-k8s-manifests` were correlated with changes in `addonfactory-workflow-addon-release`, so there is a need to backport **only necessary** changes to `v.4.16`. There are two ways to do that: by cherrypicking specific commits (and resolving the conflicts if they exist) or by commiting necessary changes manually.
- changes made in `ta-automation-k8s-manifests` were correlated with changes in `addonfactory-workflow-addon-release`, so there is a need to backport **only necessary** changes to `v4.16`. There are two ways to do that: by cherrypicking specific commits (and resolving the conflicts if they exist) or by commiting necessary changes manually.
- for example make necessary changes and commit them:
```
git add .github/workflows/reusable-build-test-release.yml
Expand All @@ -34,10 +34,10 @@ This runbook shows a real example of backporting changes correlated to `ta-autom
- in GitHub UI:
- navigate to releases
- draft a new release
- `Choose a tag`: type the tag that will be created, i.e. `v.4.16.15`
- `Choose a tag`: type the tag that will be created, i.e. `v4.16.15`
- `Target` - newly created branch `fix/bump-k8s-manifest-version`
- click on `Generate release notes`
- `Title of release` should be `v.4.16.15 backport`
- `Title of release` should be `v4.16.15 backport`
- write description of the changes
- uncheck `Set as the latest release` box
- click `Publish release`
Expand Down

0 comments on commit 5f9f6ec

Please sign in to comment.