diff --git a/README.md b/README.md index bfec9d7..b4e7c76 100644 --- a/README.md +++ b/README.md @@ -23,16 +23,40 @@ Read more on the [1Password Developer Portal](https://developer.1password.com/do ## ✨ Quickstart +### Export secrets as a step's output (recommended) + ```yml on: push jobs: hello-world: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Load secret - uses: 1password/load-secrets-action@v2 + id: load_secret + uses: 1password/load-secrets-action@v3 + env: + OP_SERVICE_ACCOUNT_TOKEN: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }} + SECRET: op://app-cicd/hello-world/secret + + - name: Print masked secret + run: 'echo "Secret: ${{ steps.load_secrets.outputs.SECRET }}"' + # Prints: Secret: *** +``` + +### Export secrets as env variables + +```yml +on: push +jobs: + hello-world: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - name: Load secret + uses: 1password/load-secrets-action@v3 with: # Export loaded secrets as environment variables export-env: true diff --git a/action.yml b/action.yml index 4e815e4..fac55de 100644 --- a/action.yml +++ b/action.yml @@ -10,7 +10,7 @@ inputs: default: "false" export-env: description: Export the secrets as environment variables - default: "true" + default: "false" version: description: Specify which 1Password CLI version to install. Defaults to "latest". default: "latest"