/octopermalinker

Browser extension to fix outdated/broken GitHub links to branches

Primary LanguageJavaScriptMIT LicenseMIT

OctoPermalinker Build Status Windows Build Status

OctoPermalinker is a browser extension that searches GitHub comments/files for links to files on branches, and adds a link to where the branch pointed when the comment/file was made/updated. This helps you avoid following a link that was broken after being posted. For context, here's some discussion about broken GitHub links: Don't link to line numbers in GitHub.

Demo

Before

Imgur

After

Imgur

Install

OctoPermalinker is available from the Chrome Web Store. If you use Firefox, install Chrome Store Foxified first.

Alternatively, you can build and install OctoPermalinker locally by following the Quick Start section of the Contributing guide.

Features

OAuth Support

Without authentication, the GitHub API allows only 60 requests per hour. You can increase this to 5,000 requests per hour by creating an OAuth token (no scopes needed) and entering it into the extension options page (at chrome://extensions/ in Chrome, or about:addons -> Extensions in Firefox).

Paste Protection

OctoPermalinker will also detect if you paste a fragile link into a comment box. When this happens, OctoPermalinker will notify you of the corresponding permalink, in case you'd like to use it instead.

Want to contribute?

Anyone can help make this project better - check out the Contributing guide!

Feedback

If you encounter a problem using OctoPermalinker, or would like to request an enhancement, feel free to create an issue.

Thanks

Legal and License

The OctoPermalinker project is not affiliated with, sponsored by, or endorsed by github, inc.

Copyright (c) 2017–present Joseph Frazier Licensed under the MIT license.