Project Skara provides contributors and reviewers with additional pull request commands that enable additional functionality. A pull request command is a comment made to a pull request that starts with a slash ("/"), for example "/integrate", "/csr" or "/sponsor". The command may appear on any line and with an arbitrary amount of whitespace in front of it, but it must be the first non whitespace characters that appear on a particular line. Pull request commands can also be placed at the end of the pull request body. Pull request commands can be used with draft pull requests.
Skara will only evaluate a given command once, so if you make a mistake and get an error message back, you need to enter a new command in a new comment. Editing the previous comment will not have any effect.
Note that if you are using Skara on Gitlab, there are built in commands that clash with some of the Skara commands. To enforce use of the Skara command and not the Gitlab variant, you can put some whitespace in front of the command in the comment. Also, you can prepend "/skara" as a prefix to the command. For instance, to execute the "/label" command, you can use "/skara label hotspot", it will be interpreted as "/label hotspot" by SKARA bot. The commands that currently conflict with GitLab commands are /reviewer, /label and /approve.
The pull request command that all contributors will use is the
/integrate command that integrates an approved pull request into a repository. This is an example where the Skara workflow differs slightly from the workflow offered by most external Git source code hosting providers - almost all external Git source code hosting providers require that a reviewer/maintainer integrates a pull request into a repository. Skara instead enables the contributor to integrate the pull request with the
/integrate command, but the contributor can only issue the
/integrate command once the pull request passes all pre-integration checks (e.g. jcheck).
/integrate command will by default squash all commits in the pull request into one, rebase the resulting commit on top of the target branch and automatically create an appropriate commit message. The squashing of all commits in the pull request enables contributors to update a pull request by simply pushing to the branch in the contributor's personal fork the pull request was created from. The rebasing of the resulting commit enables contributors to simply merge the target branch into the source branch for the pull request whenever changes from the target branch needs to be incorporated (instead of doing complicated rebases and force pushes). The automatic formatting of the commit message frees contributors from having to consider the details of the commit message format.
A hash can be supplied to
/integrate and in that case an atomic integration is performed. An atomic integration squashes and rebases on the commits on top of the given hash, and then tries to push the result. An atomic integration will fail if the supplied hash is not the head of the target branch at the moment of the push. This means that you can be sure that if you supply a hash to
/integrate, then your pull request will only be squashed and rebased on top of the given commit, nothing else. This can be useful for large and complicated changes when you are unsure about potential conflicts with other commits.
auto parameter is used to label a pull request to be automatically integrated as soon as all pre-integration checks are passing. This can be a good idea to save time when a change is comparatively benign and only the minimum amount of review is needed.
manual parameter is used to undo the effects of the
If a contributor of a pull request will be unable to perform the integration at a suitable time, they may delegate the ability to integrate to any other committer in the project. This is done using
/integrate delegate. Issuing this command will not immediately integrate a pull request, instead any committer in the project will be able to issue the
/integrate command to perform the integration. This can be undone by the original contributor running
Marks you as the sponsor of the pull request and integrates the pull request. A contributor who is not a Committer must first issues the /integrate pull request command to mark a pull request as ready for integration. Once the pull request author has issued the /integrate pull request command, a Committer must then issue the
/sponsor pull request command to integrate the pull request. The
/sponsor pull request take an optional hash for atomic integrations, just like the /integrate pull request command.
/issue [add|remove] <id>[,<id>,...]
Mark or clear one or more issues, in addition to the one specified in the pull request title, as solved by this pull request. The default action is to mark an issue as being solved. All issues solved by the pull request will be part of the resulting commit message. An issue that has wrongly been marked as solved by this pull request can be removed by the command /issue remove <id>. It is allowed to prefix the issue numeric id with the JBS project name, but it is not necessary. This command can only be used to modify the list the additional issues, not the main issue defined in the pull request title.
/issue add JDK-4567890
/issue add 4567890
/issue add 1234567,4567890
/issue remove JDK-4567890
Add a summary section to the resulting commit message of the pull request. For details on the commit message syntax, see JEP 357. A summary command alone without any text will remove an existing summary. Only use this command to add an additional summary message to a commit. It should not be used to add issues or reviewer attributions as those are handled separately and automatically.
/summary This is a one-line summary
This is a multi-line summary.
You can add as many lines as you like.
This is a multi-line, multi-paragraph summary.
You can have as many lines and as many paragraphs as you like.
This is the first line second paragraph,
and this is the second line in the second paragraph.
/contributor (add|remove) [@user | openjdk-user | Full Name <email@address>]
Adds or removes a user as a contributor to this pull request. A contributor can be specified either by their GitHub username (e.g. @openjdk-bot), their OpenJDK username (e.g. duke) or via a full name and email combination (e.g. J. Duke <firstname.lastname@example.org>). Github and OpenJDK usernames can only be used for users in the OpenJDK census. For other contributors you need to supply the full name and email address. A contributor that has incorrectly been listed as a contributor can be unlisted by issuing the command
/contributor remove <id>. The contributors will be included in the final commit message for the pull request. For full details on the commit message syntax see JEP 357.
/contributor add ehelin
/contributor add @edvbld
/contributor add J. Duke <email@example.com>
/contributor remove @edvbld
/contributor remove rwestberg
/contributor remove J. Duke <firstname.lastname@example.org>
Declares that this pull request is part of a JDK Enhancement Proposal. The linked JEP needs to be targeted before the pull request can be integrated. The command can be issued by the pull request author or a reviewer.
/reviewer (credit|remove) <username>[,<username>,...]
Give additional users credit for reviewing a pull request. The usernames can either be a username of the source code hosting provider (e.g. a GitHub username) or an OpenJDK username. Note that not all OpenJDK projects allows the pull request author to credit additional reviewers. A reviewer credited via
/reviewer credit will not count as a verified reviewer and some OpenJDK projects do not count unverified reviewers as enough for integration. A reviewer can be removed by issuing the
/reviewer remove command.
/reviewer credit @edvbld
/reviewer credit ehelin
/reviewer remove ehelin
/reviewers N [role]
Require that at least
N users with given
role (defaults to Author) review the pull request before it can be integrated. The requirements are in addition to the ones specified by the
.jcheck/conf file. For example, if the
.jcheck/conf file requires 1 Reviewer, then issuing the command "/reviewers 2" means that 1 Reviewer and 1 Author is required to integrate the pull request. Any additional invocations of this command completely supersedes any previous invocations.
/reviewers 3 reviewer
/label [add|remove] <label>[,<label>,...]
Adds or removes labels on the pull request. If no action is specified, then the action defaults to "add". Labels have the same name as the development mailing lists without the -dev suffix, e.g. the label "hotspot" corresponds to the "hotspot-dev" mailing list. The mailing list bridge will send the RFR e-mail according to the labels on the pull request. Note that only labels associated with mailing lists can be controlled with this command and not Skara specific labels which are controlled by the bots or other specific commands (e.g. clean, rfr).
/label add hotspot
/label remove build,core-libs
/cc hotspot-gc hotspot-runtime
Marks a backport pull request as clean. Skara will attempt to automatically determine if a backport pull request is a clean backport, but sometimes this automatic check fails even if the pull request could be considered clean.
If a pull request is automatically closed due to inactivity, this command can be used to re-open it.
/backport <repository> [<branch>]
/backport disable <repository> [<branch>]
/backport used in open pull request
When used in an open pull request, the /backport command adds a
Backport=repo:branch label to the PR. After the PR is integrated, the bot will create the backport branch and provides a link for creating the backport. To cancel the backport, the user can use
/backport disable command to remove the label before the PR is integrated.
Note: /backport disable can only be used in open pull requests.
/backport used in integrated pull request.
Applies the commit this pull request resulted in onto the given branch in the given repository and then shows to a link to create a pull request with the changes. The branch is optional, if not given, the default for the repository is used. If the commit does not apply then a message is shown describing the files containing conflicts. See Backports.
If the target repository is configured to support dependent pull requests, it's possible to do this with the backport command by supplying the appropriate
The pull request will be created from a branch in a shared fork of the target repository. On GitHub, this repository is owned by the openjdk-bots organization. The first time you issue the /backport command for a specific target repository, you will receive an invitation to collaborate in the fork repository. This invitation needs to be accepted to be able to further update the backport pull request with more changes.
/backport jfx jfx14
/backport jdk17u-dev pr/4711
/approval [<id>] (request|cancel) [<text>]
Requests maintainer approval for a change.
The approval process actually takes place in JBS, this command is mostly for convenience. In a pull request for a repository that requires maintainer approval, the author may use this command to add both the comment with the motivation and the correct label to any associated bugs. This can be especially useful if the author does not have a JBS account. Skara also tracks the approval labels in the associated bugs and will block integration until all bugs are approved.
The 'id' argument is needed if there are multiple bugs associated with a pull request as separate requests need to be submitted for each bug.
The 'text' argument should contain the motivation for the change. The pull request author may issue the /approval command multiple times to update the text. Note that if a request is made through this command, the comment on the bug will be created (and owned by) by a bot user, so the text can only be modified by running this command again.
Canceling a request removes the label and the comment from the bug.
/approval request My reason
/approval request My reason line1,
My reason line2,
My reason line3.
/approval JDK-123 request My reason
/approval 123 request
/approval 123 cancel
/approve [<id>] (yes|no)
Approves a request for maintainer approval by adding the appropriate labels to the associated bugs.
The /approve command is only available to repository maintainers. It can only approve existing requests.
If an 'id' is specified, then only that bug is handled, if not, all associated bugs are handled.
/approve JDK-123 yes
/approve 123 no
/author [set|remove] [@user | openjdk-user | Full Name <email@address>]
Sets or removes a user as author of this pull request. An author can be specified either by their GitHub username (e.g. @openjdk-bot), their OpenJDK username (e.g. duke) or via a full name and email combination (e.g. J. Duke <email@example.com>). Github and OpenJDK usernames can only be used for users in the OpenJDK census. For other authors you need to supply the full name and email address. An author that has incorrectly been set can be removed by issuing the command
/author remove. The author's name will be shown in the final commit message for the pull request and the pull request creator's name will be shown as the committer.
/author set @openjdk-bot
/author set J. Duke <firstname.lastname@example.org>
/author remove @openjdk-bot
Shows help for all pull request commands.