Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

...

If a pull request is automatically closed due to inactivity, this command can be used to re-open it.

/backport

Syntax

/backport <repository> [disable] <repo> [<branch>]

/backport [disable <repository> ] [<repo>]:<branch>

Description

/backport used in open 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 and defaults to the master branchIn the first syntax, the branch is optional, if not given, the default for the repository is used. In the second syntax, repo is optional, if not given, the same repository where the command is issued is used. If the commit does not apply then a message is shown describing the files containing conflicts. See 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 pr/X branch.

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.

Examples

  • /backport :jdk23
  • /backport jdk16u
  • /backport jfx jfx14
  • /backport jdk17u-dev pr/4711
  • /backport disable jdk16u
  • /backport jfx:jfx22
  • /backport disable :jfx22

/approval

Syntax

/approval [<id>] (request|cancel) [<text>]

Description

Create Requests maintainer approval request for fixes.

Only the author of the pull request is allowed to issue this command.

If the user requested approval, the 'text' will be posted to the related bug. The user will be able to update the 'text' by requesting the approval again. 

Once maintainer processed the request(either approved or rejected), the user will not be able to update or cancel the request.

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 bugIf there is only one issue associated with this pull request, the user will not need to specify the issue id. If there are more than one issues associated with this pull request, the user should request approval for each issue individually.

Examples

  • /approval request My reason
  • /approval request My reason line1,
    My reason line2,
    My reason line3.
  • /approval cancel
  • /approval JDK-123 request My reason
  • /approval 123 request
  • /approval 123 cancel

...

/approve [<id>] (yes|no)

Description

Handle user's approval request for fixes.

Only maintainers of the repository are allowed to issue this command. Maintainers can not approve or reject the approval request if the request doesn't exist.

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 if the maintainer doesn't specify issue id in this command, then all the approval request associated with this pull request will be handled.

Examples

  • /approve yes
  • /approve no
  • /approve JDK-123 yes
  • /approve 123 no

/author

Syntax

/author [set|remove] [@user | openjdk-user | Full Name <email@address>]

Description

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 <duke@openjdk.org>). 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.

Examples

  • /author set @openjdk-bot
  • /author @openjdk-bot
  • /author set J. Duke <duke@openjdk.org>
  • /author remove @openjdk-bot
  • /author remove

/touch

Syntax

/touch

Alias

/keepalive

Description

A no-op command that triggers a re-evaluation of the pull request and resets the timer for automatically closing a pull request due to inactivity. This command does not trigger sending of any emails.


/help

Syntax

/help

Description

Shows help for all pull request commands.

Examples

  • /help