2 unstable releases
0.2.0 | Mar 20, 2023 |
---|---|
0.1.0 | Feb 19, 2023 |
#894 in Authentication
17KB
328 lines
git-credential-github-app-auth
Git credential helper using GitHub App authentication to provide Github tokens as credentials to Git.
The helper will cache the credentials and only request a new token when the previous one expired.
Setup
Create a Github App and install it on the repositor or account/organization.
The app needs to have at least read-only permission for the "Contents" of the repository.
You must also generate a private key for the app in order to make API requests.
Usage
Make sure the helper binary git-credential-github-app-auth
is in your path.
The authentication agent listens on a local Unix socket and can be started with
the following command:
git-credential-github-app-auth \
/run/user/1000/github-app-auth \
agent \
--app-id 1234 \
--key-path /path/to/app/private-key.pem
Configure the Git credential helper in ~/.gitconfig
:
[credential "https://github.com"]
helper = "github-app-auth /run/user/1000/github-app-auth client"
useHttpPath = true
To test that the authentication helper works, you can either clone a repo that
has the configured Github app installed or run git credential fill
directly and provide e.g. the
following input (note the extra newline at the end; see also expected
format):
protocol=https
host=github.com
path=westphahl/git-credential-github-app-auth.git
Dependencies
~14–26MB
~498K SLoC