RFR: Section on backporting [v2]

Magnus Ihse Bursie ihse at openjdk.java.net
Wed Nov 24 11:13:22 UTC 2021


On Tue, 23 Nov 2021 21:39:45 GMT, Jesper Wilhelmsson <jwilhelm at openjdk.org> wrote:

>> Guidance on backporting.
>> Also moved "Backing out a change" to the testing section where I believe it fits better. This section is unchanged.
>
> Jesper Wilhelmsson has updated the pull request incrementally with one additional commit since the last revision:
> 
>   Fixes after reviews

Looks good in general. I fixed a typo for you. :) Also recommended some changes wrt Skara.

src/index.md line 1492:

> 1490: In general there is no need to create backport issues in JBS manually. All work that is done in JBS in preparation for a backport (requesting approvals etc) is done in the main issue. The backport issue will be created automatically by the bots when you integrate the change to the source code repository.
> 1491: 
> 1492: There can be cases where it is motivated to create a backport issue before the fix is done. In these cases set the fix version of the backport to `N-pool`, where `N` is the release train the backport is targeting. E.g. `17-pool`. Please note that even if a backport issue is created ahead of time, all work done in JBS is stil done in the main issue.

Suggestion:

There can be cases where it is motivated to create a backport issue before the fix is done. In these cases set the fix version of the backport to `N-pool`, where `N` is the release train the backport is targeting. E.g. `17-pool`. Please note that even if a backport issue is created ahead of time, all work done in JBS is still done in the main issue.

src/index.md line 1504:

> 1502: ## Using the Skara tooling to help with backports
> 1503: 
> 1504: The Skara project developed support for backports. [The official Skara documentation](https://wiki.openjdk.java.net/display/SKARA/Backports) describes in detail how to work with the tooling to create backport PRs on GitHub or using the CLI tools. As described in the documentation, the [`/backport`](https://wiki.openjdk.java.net/display/SKARA/Commit+Commands#CommitCommands-/backport) command can be used to create the backport PR. If a backport PR is manually created, set the title to `Backport <original commit hash>`.

Suggestion:

The Skara tooling includes support for backports. [The official Skara documentation](https://wiki.openjdk.java.net/display/SKARA/Backports) describes in detail how to work with the tooling to create backport PRs on GitHub or using the CLI tools. As described in the documentation, the [`/backport`](https://wiki.openjdk.java.net/display/SKARA/Commit+Commands#CommitCommands-/backport) command can be used on a commit (not a PR!) to create the backport PR. If a backport PR is manually created, set the title to `Backport <original commit hash>`.

-------------

Marked as reviewed by ihse (Author).

PR: https://git.openjdk.java.net/guide/pull/66


More information about the guide-dev mailing list