https://github.com/settlemint/setup-op

Github action to install the 1Password CLI
https://github.com/settlemint/setup-op

Last synced: 3 days ago
JSON representation

Github action to install the 1Password CLI

• Host: GitHub
• URL: https://github.com/settlemint/setup-op
• Owner: settlemint
• License: mit
• Created: 2023-05-19T07:59:47.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-31T20:03:44.000Z (4 months ago)
• Last Synced: 2024-10-01T20:16:03.026Z (about 2 months ago)
• Language: TypeScript
• Size: 298 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# :gear: `setup-op`

## About

This action sets up the 1Password CLI, [`op`](https://1password.com/downloads/command-line/), on GitHub Actions runners.

This action will install and expose a specified version of the `gh` CLI on the runner environment and will setup the authentication using a Service Account.

## Why?

1Password provides a [load-secrets-action](https://github.com/1Password/load-secrets-action) which installs the op tool and can load environment secrets, but it has some flaws:

- It does not support a specific version of the `op` CLI

- It does not support the ARM version of the `op` CLI (made a PR for this, but it was not yet merged)

- It does not use the tool cache which slows down usage of the action

- It does not expose the `op` CLI to the runner environment so you cannot use it in a different way than designed

- Launching a dozen runners with a dozen secrets each will hit your rate limits very soon, this action allows you to use `op inject` to write env files bypassing this rate limit

## Usage

Setup the `op` CLI:

```yaml

steps:

- uses: settlemint/[email protected]

  with:

    service-account-token: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}

```

A specific version of the `op` CLI can be installed:

```yaml

steps:

- uses: settlemint/[email protected]

  with:

    version: 2.18.0

    service-account-token: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}

```

## Inputs

The actions supports the following inputs:

- `version`: The version of `op` to install, defaulting to `2.18.0`

## License

Based off [the example action by Github](https://github.com/github-developer/example-setup-gh) which is [MIT](LICENSE) licensed.