DEPRECATION NOTICE: The functionality of this add-on has been merged in APT GitHub Improvements. Using this add-on directly is not recommended.

GitHub Issue PR Linker

Available on addons.mozilla.org

An add-on that inserts one-click links from GitHub issue to PRs and vice versa:

To use it, each PRs' title must include the issues they affect. Issues should be formatted as #xyz. For example, a PR with the title, Closes #123: Update readme. will create a link from issue #123 to the PR and vice versa.

This add-on will be effective for teams that are strict about their PR title formatting. For issue linking on arbitrary repositories, see the GitHub Issue Hoister.

It is highly recommended to use a GitHub Personal Access Token to increase rate limits. Otherwise, the add-on may wait to link issues under some conditions. See the user guide for more information.

Alternatives

GitHub Issue Hoister: this web browser add-on copies links to the top of the page that eventually link from an issue to PR and vice versa. For example, GitHub provides links in their issues such as "mcomella added a commit that referenced this issue". This link will link to a commit that, if part of a PR, will link to the PR associated with the issue.

In addition to the trade-offs mentioned above, if the PR title format is followed, the Issue PR Linker is simpler -- it just works and takes a single click to go from issue to PR -- but is less frequently updated and operates on a subset of PRs (due to rate limits). The Issue Hoister is more complex but is more up-to-date.

Development

Install the typescript compiler (through npm) and run with:

tsc

The options menu uses a separate compile target so if you're modifying options.ts:

tsc -p src/options

In Firefox, you can load a temporary add-on for testing. Add the -w argument for continuous compilation.

Development with Visual Studio Code is recommended, given its awareness of Typescript types.

Tests

Build and run the tests:

tsc -p spec && jasmine

Publishing

out/bundle.xpi will be created after:

./publish.sh

License

Typescript type definitions (typings/) are available via DefinitelyTyped under the MIT license. The license file is included in that directory.

The license included with this repository is based on the X11 license, which is similar to the MIT license.