Update transport version documentation #138263
Conversation
jdconrad
added
>docs
elasticsearchmachine
added
Team:Core/Infra
|
Pinging @elastic/es-core-infra (Team:Core/Infra) |
|
Pinging @elastic/core-docs (Team:Docs) |
🔍 Preview links for changed docs |
This comment was marked as off-topic.
This comment was marked as off-topic.
docs/internal/Versioning.md
Outdated
| 2. Use auto-backport from CI to merge change with the newly created transport | ||
| version into `9.1` | ||
| 3. Discover it's necessary for this change to be backported to `8.19` | ||
| 4. Generate and merge a change to add a transport version for `8.19` into `main` |
There was a problem hiding this comment.
This step is a little ambiguous. Could you rephrase it to make it more clear the "change" is the original transport version definition, not a new one?
There was a problem hiding this comment.
I re-did all of the steps to try to make things more clear.
docs/internal/Versioning.md
Outdated
| Backport branches that already included the original change can use | ||
| auto-backport in CI or cherry-pick the new transport version change. Backport | ||
| branches that did not include the original change need to cherry-pick both the | ||
| original change and the new transport version change. Summarized steps: |
There was a problem hiding this comment.
Summarized steps -> For example with the above change that is first backported to 9.1, and subsequently added to 8.19, the sequence of events would look like the following:
|
@rjernst Ready for another look. |
rjernst
left a comment
rjernst
left a comment
There was a problem hiding this comment.
A couple more minor suggestions
docs/internal/Versioning.md
Outdated
| and `TV0` into the target branch `9.1`. | ||
| 2. Discover that `C0` is also required in target branch `8.19`. | ||
| 3. Create a pull request with target branch `main` for a change (`C1`) to only | ||
| update `TV0` (`TV1`) for `8.19` |
There was a problem hiding this comment.
There shouldn't be any TV1 here, the purpose of the change is to update TV0 to include an additional id for 8.19.
Co-authored-by: Ryan Ernst <ryan@iernst.net>
Co-authored-by: Ryan Ernst <ryan@iernst.net>
Co-authored-by: Ryan Ernst <ryan@iernst.net>
This adds additional information about cherry-picking an original change when a decision has been made to add a backport version. Co-authored-by: Ryan Ernst <ryan@iernst.net>
3 participants
This adds additional information about cherry-picking an original change when a decision has been made to add a backport verison.