Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

1076: Not possible to use 'Backport <sha>' if original bug doesn't have public sha #1186

Closed
wants to merge 7 commits into from

Conversation

erikj79
Copy link
Member

@erikj79 erikj79 commented Jun 11, 2021

This patch adds a new way of declaring a pull requests to be a backport for situations where the original hash of the original change is not known or available. Technically such a PR should already work without the backport label, but it will display a warning about the issue not being open. By being able to declare a backport, that warning will be eliminated, which should make the user experience smoother and hopefully help avoid mistakes.

To use the new feature, you create a PR with a title "Backport " instead of "Backport ". Once this goes live, I will update the Skara wiki documentation.


Progress

  • Change must not contain extraneous whitespace
  • Change must be properly reviewed

Issue

  • SKARA-1076: Not possible to use 'Backport ' if original bug doesn't have public sha

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.java.net/skara pull/1186/head:pull/1186
$ git checkout pull/1186

Update a local copy of the PR:
$ git checkout pull/1186
$ git pull https://git.openjdk.java.net/skara pull/1186/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 1186

View PR using the GUI difftool:
$ git pr show -t 1186

Using diff file

Download this PR as a diff file:
https://git.openjdk.java.net/skara/pull/1186.diff

@bridgekeeper
Copy link

@bridgekeeper bridgekeeper bot commented Jun 11, 2021

👋 Welcome back erikj! A progress list of the required criteria for merging this PR into pr/1185 will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

@openjdk openjdk bot changed the title SKARA-1076 1076: Not possible to use 'Backport <sha>' if original bug doesn't have public sha Jun 11, 2021
@openjdk openjdk bot added the rfr label Jun 11, 2021
@mlbridge
Copy link

@mlbridge mlbridge bot commented Jun 11, 2021

@kevinrushforth kevinrushforth self-requested a review Jun 11, 2021
Copy link
Member

@kevinrushforth kevinrushforth left a comment

Looks good.

@@ -299,6 +299,37 @@ public String toString() {
}
}

// Check for a title on the form Backport <issueid>
Copy link
Member

@kevinrushforth kevinrushforth Jun 11, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor: "'of' the form ..."?

assertEquals(List.of("integrationreviewer3"), message.reviewers());
assertEquals(List.of(), message.contributors());
assertEquals(List.of(), message.summaries());
assertEquals(List.of(), message.additional());
Copy link
Member

@kevinrushforth kevinrushforth Jun 11, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be good to also check that the commit message does not contain "Backport of", or is this covered by checking that message.additional() is empty?

Copy link
Member Author

@erikj79 erikj79 Jun 11, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. I just removed the assert for the existence of the original hash without thinking about inverting that assert.

@openjdk-notifier openjdk-notifier bot changed the base branch from pr/1185 to master Jun 11, 2021
@openjdk-notifier
Copy link

@openjdk-notifier openjdk-notifier bot commented Jun 11, 2021

The dependent pull request has now been integrated, and the target branch of this pull request has been updated. This means that changes from the dependent pull request can start to show up as belonging to this pull request, which may be confusing for reviewers. To remedy this situation, simply merge the latest changes from the new target branch into this pull request by running commands similar to these in the local repository for your personal fork:

git checkout refactor-pr
git fetch https://git.openjdk.java.net/skara master
git merge FETCH_HEAD
# if there are conflicts, follow the instructions given by git merge
git commit -m "Merge master"
git push

@openjdk
Copy link

@openjdk openjdk bot commented Jun 11, 2021

@erikj79 This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

🔍 One or more changes in this pull request modifies files in areas of the source code that often require two reviewers. Please consider if this is the case for this pull request, and if so, await a second reviewer to approve this pull request before you integrate it.

After integration, the commit message for the final commit will be:

1076: Not possible to use 'Backport <sha>' if original bug doesn't have public sha

Reviewed-by: kcr

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been no new commits pushed to the master branch. If another commit should be pushed before you perform the /integrate command, your PR will be automatically rebased. If you prefer to avoid any potential automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

@openjdk openjdk bot added the ready label Jun 11, 2021
@kevinrushforth
Copy link
Member

@kevinrushforth kevinrushforth commented Jun 12, 2021

I just thought of one more thing you might need to handle. In the JBS issue, you mentioned two things that the "backport" label is used for:

  1. Whether to print the warning about the issue not being open.
  2. Whether to allow the /clean command to be run to mark a backport "clean".

For the case of no public SHA hash, Skara should not allow a Committer to declare it as clean. There isn't any way for anyone -- including the contributor -- to know whether or not it is clean. For the case being covered by this fix, there isn't a public patch to look at in the first place.

@erikj79
Copy link
Member Author

@erikj79 erikj79 commented Jun 14, 2021

/integrate

@openjdk openjdk bot closed this Jun 14, 2021
@openjdk openjdk bot added integrated and removed ready rfr labels Jun 14, 2021
@openjdk
Copy link

@openjdk openjdk bot commented Jun 14, 2021

@erikj79 Pushed as commit ec8b663.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants