# store-git-credential-github-action

> This action saves the GitHub credentials to the specified keychain.

Latest version **1.6.6** (published 2023-03-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install store-git-credential-github-action
pnpm add store-git-credential-github-action
yarn add store-git-credential-github-action
bun add store-git-credential-github-action
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.6.6 |
| Published | 2023-03-07 |
| First published | 2023-03-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 251.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Akio Jinsenji |
| Maintainers | akiojin |
| Keywords | git, credential, GCM |

## Links

- npm: https://www.npmjs.com/package/store-git-credential-github-action
- Repository: https://github.com/akiojin/store-git-credential-github-action
- Homepage: https://github.com/akiojin/store-git-credential-github-action#readme
- Issues: https://github.com/akiojin/store-git-credential-github-action/issues
- npm.io page: https://npm.io/package/store-git-credential-github-action

## Dependencies (3)

- [@actions/core](https://npm.io/package/@actions/core.md) ^1.10.0
- [@actions/exec](https://npm.io/package/@actions/exec.md) ^1.1.1
- [@akiojin/keychain](https://npm.io/package/@akiojin/keychain.md) ^0.2.7

## Recent versions

- 1.6.6 (latest) — 2023-03-07

## README

# store-git-credential-github-action
![Test][0]

This action saves the GitHub credentials to the specified keychain.
The GitHub credentials are deleted at the end of the workflow.

## Requirement
You will need to install [git-credential-manager-core][1]

### Installation
See [Installation][2]

```sh
brew tap microsoft/git
brew install --cask git-credential-manager-core
```
```sh
brew upgrade git-credential-manager-core
```

## Usage
### Simple usage
```yml
# Use default login.keychain-db
- uses: store-git-credential-github-action
  with:
    github-username: ${{ secrets.GIT_CREDENTIAL_USERNAME }}
    github-password: ${{ secrets.GIT_CREDENTIAL_PASSWORD }}
```

### Custom keychain usage
```yml
# Creating a temporary keychain
- uses: akiojin/setup-temporary-keychain-github-action@v1.0
  id: setup-temporary-keychain

- uses: store-git-credential-github-action
  with:
    github-username: ${{ secrets.GIT_CREDENTIAL_USERNAME }}
    github-password: ${{ secrets.GIT_CREDENTIAL_PASSWORD }}
    keychain: ${{ steps.setup-temporary-keychain.outputs.keychain }}
    keychain-password: ${{ steps.setup-temporary-keychain.outputs.keychain-password }}
```

## Additional Arguments
See [action.yml][3] for more details.

|Name|Required|Type|Default|Description|
|:--|:--|:--|:--|:--|
|`github-username`|`true`|`boolean`||GitHub username.|
|`github-password`|`true`|`boolean`||A personal access token with access to the GitHub repository.|
|`keychain`|`false`|`string`|Default keychain|Path of the keychain to use. If omitted, the default login keychain is used.|
|`keychain-password`|`false`|`string`|""|Password for the keychain if specified in the keychain parameter; default login keychain password if the kerchain parameter is omitted.|

GitHub personal access tokens can be obtained at `Settings > Developer settings > Personal access tokens`.
Access rights require `repo` permissions.

## License
Any contributions made under this project will be governed by the [MIT License][4].

[0]: https://github.com/akiojin/store-git-credential-github-action/actions/workflows/Test.yml/badge.svg
[1]: https://github.com/GitCredentialManager/git-credential-manager
[2]: https://github.com/GitCredentialManager/git-credential-manager#download-and-install
[3]: https://github.com/akiojin/store-git-credential-github-action/blob/main/action.yml
[4]: https://github.com/akiojin/store-git-credential-github-action/blob/main/LICENSE

---
_Source: https://npm.io/package/store-git-credential-github-action · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._