wiki:PullRequestsPlugin

Track the status of code repository pull requests

Description

This plugin allows you to track the status of your code repository pull requests.

A pull request (PR) is a request or proposal to submit code changes into a main code repository. Pull is standard terminology from version control systems like Git or Mercurial. Basically it is a method of submitting contributions. The contributor has a clone of the main repository, pushes the proposed changes to that clone, then submits a pull request. The pull request contains the information required to merge these changes back to the main repository. Usually this means the URL of the repository and a branch (Git) or bookmark name (Mercurial).

Example of PRs created, reviewed and closed in ticket.

By default the PR status can be "open", "reviewed" or "closed". The available status values can be configured.

Ticket comments containing a <command> PR: [arg] can create a PR or change its status.

This plugin also adds a macro that lists the queried pull requests, and it also adds a new admin panel, that lists all pull requests.

Admin panel

Create Pull Request

A new pull request is automatically created when a ticket comment contains the command open PR: <link>.

Examples:

  • open PR: changeset:123/ForkRepoName
  • open PR: log:ForkRepoName@branch
  • open PR: [https://www.example.com/git/branches/x BranchX]

The pull request number is automatically assigned and inserted into the ticket comment.

Change Status of a Pull Request

The status of a pull request is automatically changed when a ticket comment contains the command <newstatus> PR:<number>.

Examples:

  • reviewed PR:3
  • closed PR:7

Configuration

The trac.ini option [pullrequests] create_commands can be changed to allow multiple or different commands that create pull requests in different states. The status of a created pull request is always the same as the command that was used to create it.

The trac.ini option [pullrequests] update_commands can be changed to allow different commands that [ChangeStatusofaPullRequets change the pull request status]. The next status of a pull request is always the same as the command that was used to change status.

Example configuration:

[pullrequests]
create_commands = open, draft, prototype, sketch
update_commands = closed, reviewed, accepted, rejected, withdrawn, deferred, superseded, updated, verified, tested, suspended

PRQuery Macro

A new macro allows listing all pull requests by author and / or status.

Examples:

  • [[PRQuery()]]
  • [[PRQuery(status=reviewed)]]
  • [[PRQuery(status=!closed)]]
  • [[PRQuery(status=reviewed, author=joe)]]
  • [[PRQuery(status=open, author=!joe)]]

This allows creating overview wiki pages listing all relevant PRs.

Bugs/Feature Requests

Existing bugs and feature requests for PullRequestsPlugin are here.

If you have any issues, create a new ticket.

defect

5 / 6

enhancement

1 / 2

Download

Download the zipped source from here.

Source

You can check out PullRequestsPlugin from here using Subversion, or browse the source with Trac.

Trac Plugin
>=1.4 trunk
>=1.2 1.1

Installation

General instructions on installing Trac plugins can be found on the TracPlugins page.

Recent Changes

17486 by lucid on 2019-09-03 20:40:11
PullRequestsPlugin: Fix selected options.
Jinja does not remove attributes with value None anymore.
(see #13594)
17475 by lucid on 2019-08-31 09:55:30
PullRequestsPlugin: Support Trac 1.5.1+ using Jinja templates.
Bump version to 1.2
Refs #13594.
17474 by lucid on 2019-08-31 09:52:50
PullRequestsPlugin: tag version 1.1

Version 1.1 is compatible with Trac 1.2.

Refs #13594.

(more)

Author/Contributors

Author: lucid
Maintainer: lucid
Contributors:

Last modified 3 weeks ago Last modified on Aug 31, 2019, 9:56:34 AM

Attachments (2)

Download all attachments as: .zip