git-permalink

Git extension to generate web permalinks of files in a repository.

It knows about many of the existing code forges, but allows for URL template overrides to be used on custom domains or deployments via git config.

Usage

# setup example "remembering" repository
$ git clone git://euandreh.xyz/remembering
$ cd remembering/

Now inside the repository folder, running git permalink will try build the web URL of the given file use xdg-open to launch the browser (or whatever is configured):

$ git permalink tests/ranking.sh
Opening https://git.euandreh.xyz/remembering/tree/tests/ranking.sh?id=44533e2df144e7749a382e298aea53ca11a2239e
$ git permalink tests/ranking.sh 23
Opening https://git.euandreh.xyz/remembering/tree/tests/ranking.sh?id=44533e2df144e7749a382e298aea53ca11a2239e#n23

Or if you just want to output the link without invoking xdg-open, you can use the -p flag:

$ git permalink -p tests/ranking.sh 23
https://git.euandreh.xyz/remembering/tree/tests/ranking.sh?id=44533e2df144e7749a382e298aea53ca11a2239e#n23

Installation

$ make
$ [sudo] make install

You can pass PREFIX or DESTDIR to make if you'd like:

$ make PREFIX=$HOME/.local
$ make PREFIX=$HOME/.local install

There are no dependencies or requirements, only standard tools such as sed, mkdir, etc.

Documentation

The documentation is available via installed manpages or online: [git-permalink.1] (pt, fr, eo).

Contributing

Extra tools used for development are: - ShellCheck for validating scripts; - po4a and gettext for i18n and l10n support; - pandoc and Perl for generating the documentation HTML and website.

For running the extra development-only checks, run:

$ make dev-check

and for generating the documentation HTML and website, run:

$ make public

Send contributions to the mailing list via git send-email.

Links

• homepage
• source code
• bug tracking
• mailing list
• CI logs
• CHANGELOG

Releases

• v0.2.2 git-permalink-v0.2.2.tar.gz (sig), released in 2021-06-25
• v0.2.1 git-permalink-v0.2.1.tar.gz (sig), released in 2021-06-25
• v0.2.0 git-permalink-v0.2.0.tar.gz (sig), released in 2021-06-19
• v0.1.0 git-permalink-v0.1.0.tar.gz (sig), released in 2021-06-13

License

The code is licensed under GNU Affero General Public License v3.0 or later (AGPL-3.0-or-later).