Added basic usage examples to readme

Update readme to link to developer portal
This MR updates the readme to: - Match the final edited text used in the developer portal - Link out to the developer portal for usage examples beyond basic setup
2022-10-18 09:03:48 -04:00 · 2022-10-03 09:26:54 -04:00
17 changed files with 506 additions and 16556 deletions
--- a/.github/workflows/lint.yml
+++ b/.github/workflows/lint.yml
@@ -5,9 +5,6 @@ jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
-      - uses: actions/checkout@v3
-      - name: Run ShellCheck
-        uses: ludeeus/action-shellcheck@2.0.0
-        with:
-          ignore_paths: >-
-            .husky
+      - uses: actions/checkout@v2
+      - name: ShellCheck
+        uses: ludeeus/action-shellcheck@1.1.0
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@@ -2,40 +2,24 @@ on: push
 name: Run acceptance tests

 jobs:
-  test-with-output-secrets:
-    strategy:
-      matrix:
-        os: [ ubuntu-latest, macos-latest ]
-        auth: [ connect, service-account ]
-        exclude:
-          - os: macos-latest
-            auth: connect
-    runs-on: ${{ matrix.os }}
+  use-connect-without-export-env:
+    runs-on: ubuntu-latest
    steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v2
      - name: Launch 1Password Connect instance
-        if: ${{ matrix.auth == 'connect' }}
        env:
          OP_CONNECT_CREDENTIALS: ${{ secrets.OP_CONNECT_CREDENTIALS }}
        run: |
          echo "$OP_CONNECT_CREDENTIALS" > 1password-credentials.json
          docker-compose -f tests/fixtures/docker-compose.yml up -d && sleep 10
-      - name: Configure Service account
-        if: ${{ matrix.auth == 'service-account' }}
-        uses: ./configure
-        with:
-          service-account-token: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
      - name: Configure 1Password Connect
-        if: ${{ matrix.auth == 'connect' }}
        uses: ./configure # 1password/load-secrets-action/configure@<version>
        with:
-          connect-host: localhost:8080
+          connect-host: http://localhost:8080
          connect-token: ${{ secrets.OP_CONNECT_TOKEN }}
      - name: Load secrets
        id: load_secrets
        uses: ./ # 1password/load-secrets-action@<version>
-        with:
-          export-env: false
        env:
          SECRET: op://acceptance-tests/test-secret/password
          SECRET_IN_SECTION: op://acceptance-tests/test-secret/test-section/password
@@ -46,31 +30,17 @@ jobs:
          SECRET_IN_SECTION: ${{ steps.load_secrets.outputs.SECRET_IN_SECTION }}
          MULTILINE_SECRET: ${{ steps.load_secrets.outputs.MULTILINE_SECRET }}
        run: ./tests/assert-env-set.sh
-  test-with-export-env:
-    strategy:
-      matrix:
-        os: [ ubuntu-latest, macos-latest ]
-        auth: [ connect, service-account ]
-        exclude:
-          - os: macos-latest
-            auth: connect
-    runs-on: ${{ matrix.os }}
+  use-connect-with-export-env:
+    runs-on: ubuntu-latest
    steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v2
      - name: Launch 1Password Connect instance
-        if: ${{ matrix.auth == 'connect' }}
        env:
          OP_CONNECT_CREDENTIALS: ${{ secrets.OP_CONNECT_CREDENTIALS }}
        run: |
          echo "$OP_CONNECT_CREDENTIALS" > 1password-credentials.json
          docker-compose -f tests/fixtures/docker-compose.yml up -d && sleep 10
-      - name: Configure Service account
-        if: ${{ matrix.auth == 'service-account' }}
-        uses: ./configure
-        with:
-          service-account-token: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
      - name: Configure 1Password Connect
-        if: ${{ matrix.auth == 'connect' }}
        uses: ./configure # 1password/load-secrets-action/configure@<version>
        with:
          connect-host: http://localhost:8080
@@ -78,6 +48,8 @@ jobs:
      - name: Load secrets
        id: load_secrets
        uses: ./ # 1password/load-secrets-action@<version>
+        with:
+          export-env: true
        env:
          SECRET: op://acceptance-tests/test-secret/password
          SECRET_IN_SECTION: op://acceptance-tests/test-secret/test-section/password
@@ -90,31 +62,17 @@ jobs:
          unset-previous: true
      - name: Assert removed secrets
        run: ./tests/assert-env-unset.sh
-  test-references-with-ids:
-    strategy:
-      matrix:
-        os: [ ubuntu-latest, macos-latest ]
-        auth: [ connect, service-account ]
-        exclude:
-          - os: macos-latest
-            auth: connect
-    runs-on: ${{ matrix.os }}
+  use-connect-with-references-with-id:
+    runs-on: ubuntu-latest
    steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v2
      - name: Launch 1Password Connect instance
-        if: ${{ matrix.auth == 'connect' }}
        env:
          OP_CONNECT_CREDENTIALS: ${{ secrets.OP_CONNECT_CREDENTIALS }}
        run: |
          echo "$OP_CONNECT_CREDENTIALS" > 1password-credentials.json
          docker-compose -f tests/fixtures/docker-compose.yml up -d && sleep 10
-      - name: Configure Service account
-        if: ${{ matrix.auth == 'service-account' }}
-        uses: ./configure
-        with:
-          service-account-token: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
      - name: Configure 1Password Connect
-        if: ${{ matrix.auth == 'connect' }}
        uses: ./configure # 1password/load-secrets-action/configure@<version>
        with:
          connect-host: http://localhost:8080
@@ -122,8 +80,6 @@ jobs:
      - name: Load secrets
        id: load_secrets
        uses: ./ # 1password/load-secrets-action@<version>
-        with:
-          export-env: false
        env:
          SECRET: op://v5pz6venw4roosmkzdq2nhpv6u/hrgkzhrlvscomepxlgafb2m3ca/password
          SECRET_IN_SECTION: op://v5pz6venw4roosmkzdq2nhpv6u/hrgkzhrlvscomepxlgafb2m3ca/Section_tco6nsqycj6jcbyx63h5isxcny/doxu3mhkozcznnk5vjrkpdqayy
@@ -134,3 +90,73 @@ jobs:
          SECRET_IN_SECTION: ${{ steps.load_secrets.outputs.SECRET_IN_SECTION }}
          MULTILINE_SECRET: ${{ steps.load_secrets.outputs.MULTILINE_SECRET }}
        run: ./tests/assert-env-set.sh
+  use-service-account-without-export-env:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Load secrets
+        id: load_secrets
+        uses: ./ # 1password/load-secrets-action@<version>
+        env:
+          OP_SERVICE_ACCOUNT_TOKEN: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
+          SECRET: op://acceptance-tests/test-secret/password
+          SECRET_IN_SECTION: op://acceptance-tests/test-secret/test-section/password
+          MULTILINE_SECRET: op://acceptance-tests/multiline-secret/notesPlain
+      - name: Assert test secret values
+        env:
+          SECRET: ${{ steps.load_secrets.outputs.SECRET }}
+          SECRET_IN_SECTION: ${{ steps.load_secrets.outputs.SECRET_IN_SECTION }}
+          MULTILINE_SECRET: ${{ steps.load_secrets.outputs.MULTILINE_SECRET }}
+        run: ./tests/assert-env-set.sh
+  use-service-account-with-export-env:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Load secrets
+        id: load_secrets
+        uses: ./ # 1password/load-secrets-action@<version>
+        with:
+          export-env: true
+        env:
+          OP_SERVICE_ACCOUNT_TOKEN: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
+          SECRET: op://acceptance-tests/test-secret/password
+          SECRET_IN_SECTION: op://acceptance-tests/test-secret/test-section/password
+          MULTILINE_SECRET: op://acceptance-tests/multiline-secret/notesPlain
+      - name: Assert test secret values
+        run: ./tests/assert-env-set.sh
+  use-service-account-with-references-with-id:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Load secrets
+        id: load_secrets
+        uses: ./ # 1password/load-secrets-action@<version>
+        env:
+          OP_SERVICE_ACCOUNT_TOKEN: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
+          SECRET: op://v5pz6venw4roosmkzdq2nhpv6u/hrgkzhrlvscomepxlgafb2m3ca/password
+          SECRET_IN_SECTION: op://v5pz6venw4roosmkzdq2nhpv6u/hrgkzhrlvscomepxlgafb2m3ca/Section_tco6nsqycj6jcbyx63h5isxcny/doxu3mhkozcznnk5vjrkpdqayy
+          MULTILINE_SECRET: op://v5pz6venw4roosmkzdq2nhpv6u/ghtz3jvcc6dqmzc53d3r3eskge/notesPlain
+      - name: Assert test secret values
+        env:
+          SECRET: ${{ steps.load_secrets.outputs.SECRET }}
+          SECRET_IN_SECTION: ${{ steps.load_secrets.outputs.SECRET_IN_SECTION }}
+          MULTILINE_SECRET: ${{ steps.load_secrets.outputs.MULTILINE_SECRET }}
+        run: ./tests/assert-env-set.sh
+  run-on-macos-12:
+    runs-on: macos-12
+    steps:
+      - uses: actions/checkout@v2
+      - name: Load secrets
+        id: load_secrets
+        uses: ./ # 1password/load-secrets-action@<version>
+        env:
+          OP_SERVICE_ACCOUNT_TOKEN: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
+          SECRET: op://acceptance-tests/test-secret/password
+          SECRET_IN_SECTION: op://acceptance-tests/test-secret/test-section/password
+          MULTILINE_SECRET: op://acceptance-tests/multiline-secret/notesPlain
+      - name: Assert test secret values
+        env:
+          SECRET: ${{ steps.load_secrets.outputs.SECRET }}
+          SECRET_IN_SECTION: ${{ steps.load_secrets.outputs.SECRET_IN_SECTION }}
+          MULTILINE_SECRET: ${{ steps.load_secrets.outputs.MULTILINE_SECRET }}
+        run: ./tests/assert-env-set.sh
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1 @@
-coverage/
 node_modules/
--- a/README.md
+++ b/README.md
@@ -1,38 +1,38 @@
 # Load Secrets from 1Password - GitHub Action

-This action loads secrets from 1Password into GitHub Actions using [1Password Connect](https://developer.1password.com/docs/connect) or a [Service Account <sup>[BETA]</sup>](https://developer.1password.com/docs/service-accounts).
+`load-secrets-action` loads secrets from 1Password into GitHub Actions using [1Password Connect](https://developer.1password.com/docs/connect).

 Specify in your workflow YAML file which secrets from 1Password should be loaded into your job, and the action will make them available as environment variables for the next steps.

-Read more on the [1Password Developer Portal](https://developer.1password.com/docs/ci-cd/github-actions).
-
 ## Requirements

 Before you get started, you'll need to:

- [Deploy 1Password Connect](/docs/connect/get-started#step-2-deploy-1password-connect-server) in your infrastructure.
+- [Deploy 1Password Connect](https://developer.1password.com/docs/connect/get-started#step-2-deploy-1password-connect-server) in your infrastructure.
 - Set the `OP_CONNECT_HOST` and `OP_CONNECT_TOKEN` environment variables to your Connect instance's credentials, so it'll be used to load secrets.

-_Supported runners_: You can run the action on Mac and Linux runners. Windows is currently not supported.
+### Supported runners
+
+You can run the action on Mac and Linux runners. Windows is currently not supported.
+
+## 1Password configuration
+
+By default, you'll need to set the environment variables for your Connect instance in the step that uses `load-secrets-action`.
+
+If you're using the action more than once in a single job, [you can use the `configure` action](https://developer.1password.com/docs/connect/github-actions/#1password-configuration) to set the environment variables instead, so you don't have to set them separately in each `load-secrets-action` step.

 ## Usage

-You can configure the action to use your 1Password Connect instance.
+You can load secrets using the action in two ways:

-If you provide `OP_CONNECT_HOST` and `OP_CONNECT_TOKEN` variables, the Connect instance will be used to load secrets. Make sure [1Password Connect](https://support.1password.com/secrets-automation/#step-2-deploy-a-1password-connect-server) is deployed in your infrastructure.
-
-If you provide `OP_SERVICE_ACCOUNT_TOKEN` variable, the service account will be used to load secrets.
-
-**_Note_**: If all environment variables have been set, the Connect credentials will take precedence over the provided service account token. You must unset the Connect environment variables to ensure the action uses the service account token.
-
-There are two ways that secrets can be loaded:
-
- [use the secrets from the action's ouput](#use-secrets-from-the-actions-output)
- [export secrets as environment variables](#export-secrets-as-environment-variables)
+1. [Use secrets from the action's output](#use-secrets-from-the-actions-output)
+2. [Export secrets as environment variables](#export-secrets-as-environment-variables)

 ### Use secrets from the action's output

-This method allows for you to use the loaded secrets as an output from the step: `steps.step-id.outputs.secret-name`. You will need to set an id for the step that uses this action to be able to access its outputs. For more details, , see [`outputs.<output_id>`](https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#outputsoutput_id).
+This method allows you to use the loaded secrets outputted by the step: `steps.step-id.outputs.secret-name`.
+
+You'll need to set an ID for the step to be able to access its outputs. For more information, see [`outputs.<output_id>`](https://docs.github.com/actions/creating-actions/metadata-syntax-for-github-actions#outputsoutput_id).

 ```yml
 on: push
@@ -40,13 +40,11 @@ jobs:
  hello-world:
    runs-on: ubuntu-latest
    steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v2

      - name: Load secret
        id: op-load-secret
        uses: 1password/load-secrets-action@v1
-        with:
-          export-env: false
        env:
          OP_CONNECT_HOST: <Your Connect instance URL>
          OP_CONNECT_TOKEN: ${{ secrets.OP_CONNECT_TOKEN }}
@@ -57,126 +55,11 @@ jobs:
        # Prints: Secret: ***
 ```

-<details>
-<summary><b>Usage example with Service Accounts <sup>BETA</sup></b></summary>
-
-```yml
-on: push
-jobs:
-  hello-world:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Load secret
-        id: op-load-secret
-        uses: 1password/load-secrets-action@v1
-        with:
-          export-env: false
-        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.op-load-secret.outputs.SECRET }}"
-        # Prints: Secret: ***
-```
-
-</details>
-
-<details>
-<summary><b>Longer usage example</b></summary>
-
-```yml
-on: push
-name: Deploy app
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Configure 1Password Connect
-        uses: 1password/load-secrets-action/configure@v1
-        with:
-          # Persist the 1Password Connect URL for next steps. You can also persist
-          # the Connect token using input `connect-token`, but keep in mind that
-          # this will grant all steps of the job access to the token.
-          connect-host: https://1password.acme.com
-
-      - name: Load Docker credentials
-        id: load-docker-credentials
-        uses: 1password/load-secrets-action@v1
-        with:
-          export-env: false
-        env:
-          OP_CONNECT_TOKEN: ${{ secrets.OP_CONNECT_TOKEN }}
-          DOCKERHUB_USERNAME: op://app-cicd/docker/username
-          DOCKERHUB_TOKEN: op://app-cicd/docker/token
-
-      - name: Login to Docker Hub
-        uses: docker/login-action@v2
-        with:
-          username: ${{ steps.load-docker-credentials.outputs.DOCKERHUB_USERNAME }}
-          password: ${{ steps.load-docker-credentials.outputs.DOCKERHUB_TOKEN }}
-
-      - name: Build and push Docker image
-        uses: docker/build-push-action@v3
-        with:
-          push: true
-          tags: acme/app:latest
-```
-
-</details>
-
-<details>
-<summary><b>Longer usage example with Service Accounts <sup>BETA</sup></b></summary>
-
-```yml
-on: push
-name: Deploy app
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Configure 1Password Connect
-        uses: 1password/load-secrets-action/configure@v1
-        with:
-          # Persist the 1Password Service Account token. This will grant
-          # all steps of the job access to the token.
-          service-account-token: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
-
-      - name: Load Docker credentials
-        id: load-docker-credentials
-        uses: 1password/load-secrets-action@v1
-        with:
-          export-env: false
-        env:
-          DOCKERHUB_USERNAME: op://app-cicd/docker/username
-          DOCKERHUB_TOKEN: op://app-cicd/docker/token
-
-      - name: Login to Docker Hub
-        uses: docker/login-action@v2
-        with:
-          username: ${{ steps.load-docker-credentials.outputs.DOCKERHUB_USERNAME }}
-          password: ${{ steps.load-docker-credentials.outputs.DOCKERHUB_TOKEN }}
-
-      - name: Build and push Docker image
-        uses: docker/build-push-action@v3
-        with:
-          push: true
-          tags: acme/app:latest
-```
-
-</details>
+[Read the full documentation for more usage examples.](https://developer.1password.com/docs/connect/github-actions/#use-secrets-from-the-actions-output)

 ### Export secrets as environment variables

-This method, allows the action to access the loaded secrets as environment variables. These environment variables are accessible at a job level.
+This method allows the action to access the loaded secrets as environment variables. These environment variables are accessible at a job level.

 ```yml
 on: push
@@ -184,32 +67,7 @@ jobs:
  hello-world:
    runs-on: ubuntu-latest
    steps:
-      - uses: actions/checkout@v3
-
-      - name: Load secret
-        uses: 1password/load-secrets-action@v1
-        with:
-          # Export loaded secrets as environment variables
-          export-env: true
-        env:
-          OP_SERVICE_ACCOUNT_TOKEN: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
-          SECRET: op://app-cicd/hello-world/secret
-
-      - name: Print masked secret
-        run: echo "Secret: $SECRET"
-        # Prints: Secret: ***
-```
-
-<details>
-<summary><b>Usage example with Service Accounts <sup>BETA</sup></b></summary>
-
-```yml
-on: push
-jobs:
-  hello-world:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v2

      - name: Load secret
        uses: 1password/load-secrets-action@v1
@@ -226,234 +84,11 @@ jobs:
        # Prints: Secret: ***
 ```

-</details>
-
-<details>
-<summary><b>Longer usage example</b></summary>
-
-```yml
-on: push
-name: Deploy app
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Configure 1Password Connect
-        uses: 1password/load-secrets-action/configure@v1
-        with:
-          # Persist the 1Password Connect URL for next steps. You can also persist
-          # the Connect token using input `connect-token`, but keep in mind that
-          # this will grant all steps of the job access to the token.
-          connect-host: https://1password.acme.com
-
-      - name: Load Docker credentials
-        uses: 1password/load-secrets-action@v1
-        with:
-          # Export loaded secrets as environment variables
-          export-env: true
-        env:
-          OP_CONNECT_TOKEN: ${{ secrets.OP_CONNECT_TOKEN }}
-          DOCKERHUB_USERNAME: op://app-cicd/docker/username
-          DOCKERHUB_TOKEN: op://app-cicd/docker/token
-
-      - name: Login to Docker Hub
-        uses: docker/login-action@v2
-        with:
-          username: ${{ env.DOCKERHUB_USERNAME }}
-          password: ${{ env.DOCKERHUB_TOKEN }}
-
-      - name: Print environment variables with masked secrets
-        run: printenv
-
-      - name: Build and push Docker image
-        uses: docker/build-push-action@v3
-        with:
-          push: true
-          tags: acme/app:latest
-
-      - name: Load AWS credentials
-        uses: 1password/load-secrets-action@v1
-        with:
-          # Export loaded secrets as environment variables
-          export-env: true
-          # Remove local copies of the Docker credentials, which aren't needed anymore
-          unset-previous: true
-        env:
-          OP_CONNECT_TOKEN: ${{ secrets.OP_CONNECT_TOKEN }}
-          AWS_ACCESS_KEY_ID: op://app-cicd/aws/access-key-id
-          AWS_SECRET_ACCESS_KEY: op://app-cicd/aws/secret-access-key
-
-      - name: Deploy app
-        # This script expects AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY to be set.
-        # This happened using secret references in the preceding lines.
-        run: ./deploy.sh
-```
-
-</details>
-
-<details>
-<summary><b>Longer usage example with Service Accounts <sup>BETA</sup></b></summary>
-
-```yml
-on: push
-name: Deploy app
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Configure 1Password Connect
-        uses: 1password/load-secrets-action/configure@v1
-        with:
-          # Persist the 1Password Service Account token. This will grant
-          # all steps of the job access to the token.
-          service-account-token: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
-
-      - name: Load Docker credentials
-        uses: 1password/load-secrets-action@v1
-        with:
-          # Export loaded secrets as environment variables
-          export-env: true
-        env:
-          DOCKERHUB_USERNAME: op://app-cicd/docker/username
-          DOCKERHUB_TOKEN: op://app-cicd/docker/token
-
-      - name: Login to Docker Hub
-        uses: docker/login-action@v2
-        with:
-          username: ${{ env.DOCKERHUB_USERNAME }}
-          password: ${{ env.DOCKERHUB_TOKEN }}
-
-      - name: Print environment variables with masked secrets
-        run: printenv
-
-      - name: Build and push Docker image
-        uses: docker/build-push-action@v3
-        with:
-          push: true
-          tags: acme/app:latest
-
-      - name: Load AWS credentials
-        uses: 1password/load-secrets-action@v1
-        with:
-          # Export loaded secrets as environment variables
-          export-env: true
-          # Remove local copies of the Docker credentials, which aren't needed anymore
-          unset-previous: true
-        env:
-          AWS_ACCESS_KEY_ID: op://app-cicd/aws/access-key-id
-          AWS_SECRET_ACCESS_KEY: op://app-cicd/aws/secret-access-key
-
-      - name: Deploy app
-        # This script expects AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY to be set.
-        # This happened using secret references in the preceding lines.
-        run: ./deploy.sh
-```
-
-</details>
-
-## Action Inputs
-
-| Name             | Default | Description                                                                        |
-| ---------------- | ------- | ---------------------------------------------------------------------------------- |
-| `export-env`     | `true`  | Export the loaded secrets as environment variables                                 |
-| `unset-previous` | `false` | Whether to unset environment variables populated by 1Password in earlier job steps |
-
-## Secrets Reference Syntax
-
-To specify which secret should be loaded into which environment variable, the action will look for `op://` reference URIs in environment variables, and replace those with the actual secret values.
-
-These reference URIs have the following syntax:
-
-> `op://<vault>/<item>[/<section>]/<field>`
-
-So for example, the reference URI `op://app-cicd/aws/secret-access-key` would be interpreted as:
-
- **Vault:** `app-cicd`
- **Item:** `aws`
- **Section:** default section
- **Field:** `secret-access-key`
+[Read the full documentation for more usage examples.](https://developer.1password.com/docs/connect/github-actions/#export-secrets-as-environment-variables)

 ## Masking

-Similar to regular GitHub repository secrets, fields from 1Password will automatically be masked from the GitHub Actions logs too.
-So if one of these values accidentally gets printed, it'll get replaced with `***`.
-
-## 1Password Configuration
-
-To use the action with Connect, you need to have a [1Password Connect](https://support.1password.com/secrets-automation/#step-1-set-up-a-secrets-automation-workflow) instance deployed somewhere.
-To configure the action with your Connect host and token, set the `OP_CONNECT_HOST` and `OP_CONNECT_TOKEN` environment variables.
-
-To configure the action with your service account token <sup>BETA</sup>, set the `OP_SERVICE_ACCOUNT_TOKEN` environment variable.
-
-If you're using the `load-secrets` action more than once in a single job, you can use the `configure` action to avoid duplicate configuration:
-
-```yml
-on: push
-jobs:
-  hello-world:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Configure 1Password Connect
-        uses: 1password/load-secrets-action/configure@v1
-        with:
-          connect-host: <Your Connect instance URL>
-          connect-token: ${{ secrets.OP_CONNECT_TOKEN }}
-      - name: Load secret
-        uses: 1password/load-secrets-action@v1
-        env:
-          SECRET: op://app-cicd/hello-world/secret
-```
-
-### `configure` Action Inputs
-
-| Name                    | Environment variable       | Description                                              |
-| ----------------------- | -------------------------- | -------------------------------------------------------- |
-| `connect-host`          | `OP_CONNECT_HOST`          | Your 1Password Connect instance URL                      |
-| `connect-token`         | `OP_CONNECT_TOKEN`         | Token to authenticate to your 1Password Connect instance |
-| `service-account-token` | `OP_SERVICE_ACCOUNT_TOKEN` | Your 1Password service account token                     |
-
-## Supported Runners
-
-You can run the action on Linux and macOS runners. Windows is currently not supported.
-
-## Warnings
-
-If you're using the CLI in your GitHub pipelines and you want to create items with it, the following command will fail:
-
-```
-op item create --category=login --title='My Example Item' --vault='Test' \
-                --url https://www.acme.com/login \
-                --generate-password=20,letters,digits \
-                username=jane@acme.com \
-                'Test Field 1=my test secret' \
-                'Test Section 1.Test Field2[text]=Jane Doe' \
-                'Test Section 1.Test Field3[date]=1995-02-23' \
-                'Test Section 2.Test Field4[text]='$myNotes
-```
-
-This is caused by the fact that the environment in these pipelines is in piped mode, which triggers the CLI's pipe detection to expect a piped input.
-To be able to create items in such environments, do the following steps:
-
-1. Get the template of the item category you want:
-
-   ```sh
-   op item template get --out-file=new-item.json <category>
-   ```
-
-2. Edit [the template](https://developer.1password.com/docs/cli/item-template-json) to add your information.
-3. Pipe the item content to the command:
-
-   ```sh
-   cat new-item.json | op item create --vault='Test'
-   ```
+Similar to regular GitHub repository secrets, fields from 1Password will automatically be masked in GitHub Actions logs. If one of these values accidentally gets printed, it'll be replaced with `***`.

 ## Security

@@ -461,8 +96,11 @@ To be able to create items in such environments, do the following steps:

 Please file requests through [BugCrowd](https://bugcrowd.com/agilebits).

-For information about our security practices, visit the [1Password Security homepage](https://1password.com/security).
+[Learn more about our security practices.](https://bugcrowd.com/agilebits)

-## Getting help
+## Get help
+
+If you find yourself stuck, [contact 1Password support](https://support.1password.com/) for help.
+
+[Read the full documentation](https://developer.1password.com/docs/connect/github-actions/).

-If you find yourself stuck, visit our [**Support Page**](https://support.1password.com/) for help.
--- a/action.yml
+++ b/action.yml
@@ -7,10 +7,10 @@ branding:
 inputs:
  unset-previous:
    description: Whether to unset environment variables populated by 1Password in earlier job steps
-    default: "false"
+    default: false
  export-env:
    description: Export the secrets as environment variables
-    default: "true"
+    default: false
 runs:
-  using: "node16"
-  main: "dist/index.js"
+  using: 'node16'
+  main: 'dist/index.js'
--- a/config/.husky/pre-commit
+++ b/config/.husky/pre-commit
@@ -1,4 +0,0 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-npx lint-staged --config ./config/lint-staged.config.js
--- a/config/.husky/pre-push
+++ b/config/.husky/pre-push
@@ -1,4 +0,0 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-npm run validate
--- a/config/.prettierignore
+++ b/config/.prettierignore
@@ -1,3 +0,0 @@
-coverage/
-dist/
-node_modules/
--- a/config/jest.config.js
+++ b/config/jest.config.js
@@ -1,19 +0,0 @@
-const jestConfig = {
-	/**
-	 * Jest docs: "We recommend placing the extensions most commonly used in your project
-	 *             on the left, so if you are using TypeScript, you may want to consider
-	 *             moving 'ts' to the beginning of the array."
-	 *
-	 * https://jestjs.io/docs/configuration#modulefileextensions-arraystring
-	 */
-	moduleFileExtensions: ["ts", "js", "json"],
-	rootDir: "../src/",
-	testEnvironment: "node",
-	testRegex: "(/__tests__/.*|(\\.|/)test)\\.ts",
-	transform: {
-		".ts": ["ts-jest"],
-	},
-	verbose: true,
-};
-
-export default jestConfig;
--- a/config/lint-staged.config.js
+++ b/config/lint-staged.config.js
@@ -1,9 +0,0 @@
-const lintStagedConfig = {
-	// run formatting and linting on all supported file types
-	"*.{js,json,md,ts,yaml,yml}": "npm run format:write",
-	"*.{js,ts}": ["npm run lint:fix"],
-	// run testing on all supported file types within the src/ directory
-	"src/**/*.{js,ts}": ["npm run test -- --findRelatedTests"],
-};
-
-export default lintStagedConfig;
--- a/dist/index.js
+++ b/dist/index.js
--- a/dist/package.json
+++ b/dist/package.json
@@ -1,3 +0,0 @@
-{
-  "type": "module"
-}
--- a/entrypoint.sh
+++ b/entrypoint.sh
@@ -2,11 +2,6 @@
 # shellcheck disable=SC2046,SC2001,SC2086
 set -e

-# Pass User-Agent Inforomation to the 1Password CLI
-export OP_INTEGRATION_NAME="1Password GitHub Action"
-export OP_INTEGRATION_ID="GHA"
-export OP_INTEGRATION_BUILDNUMBER="1010001"
-
 readonly CONNECT="CONNECT"
 readonly SERVICE_ACCOUNT="SERVICE_ACCOUNT"

@@ -14,10 +9,6 @@ auth_type=$CONNECT
 managed_variables_var="OP_MANAGED_VARIABLES"
 IFS=','

-if [[ "$OP_CONNECT_HOST" != "http://"* ]] && [[ "$OP_CONNECT_HOST" != "https://"* ]]; then
-  export OP_CONNECT_HOST="http://"$OP_CONNECT_HOST
-fi
-
 # Unset all secrets managed by 1Password if `unset-previous` is set.
 unset_prev_secrets() {
  if [ "$INPUT_UNSET_PREVIOUS" == "true" ]; then
@@ -39,28 +30,12 @@ unset_prev_secrets() {

 # Install op-cli
 install_op_cli() {
-  OP_INSTALL_DIR="$(mktemp -d)"
-  if [[ ! -d "$OP_INSTALL_DIR" ]]; then
-    echo "Install dir $OP_INSTALL_DIR not found"
-    exit 1
-  fi
-  export OP_INSTALL_DIR
-  echo "::debug::OP_INSTALL_DIR: ${OP_INSTALL_DIR}"
  if [[ "$OSTYPE" == "linux-gnu"* ]]; then
-    curl -sSfLo op.zip "https://cache.agilebits.com/dist/1P/op2/pkg/v2.10.0-beta.02/op_linux_amd64_v2.10.0-beta.02.zip"
-    unzip -od "$OP_INSTALL_DIR" op.zip && rm op.zip
+    curl -sSfLo op.zip "https://cache.agilebits.com/dist/1P/op2/pkg/v2.7.1-beta.01/op_linux_amd64_v2.7.1-beta.01.zip"
+    unzip -od /usr/local/bin/ op.zip && rm op.zip
  elif [[ "$OSTYPE" == "darwin"* ]]; then
-    curl -sSfLo op.pkg "https://cache.agilebits.com/dist/1P/op2/pkg/v2.10.0-beta.02/op_apple_universal_v2.10.0-beta.02.pkg"
-    pkgutil --expand op.pkg temp-pkg
-    tar -xvf temp-pkg/op.pkg/Payload -C "$OP_INSTALL_DIR"
-    rm -rf temp-pkg && rm op.pkg
-  fi
-}
-
-# Uninstall op-cli
-uninstall_op_cli() {
-  if [[ -d "$OP_INSTALL_DIR" ]]; then
-    rm -fr "$OP_INSTALL_DIR"
+    curl -sSfLo op.pkg "https://cache.agilebits.com/dist/1P/op2/pkg/v2.7.1-beta.01/op_apple_universal_v2.7.1-beta.01.pkg"
+    sudo installer -pkg op.pkg -target /usr/local/bin/ && rm op.pkg
  fi
 }

@@ -68,7 +43,7 @@ populating_secret() {
  ref=$(printenv $1)

  echo "Populating variable: $1"
-  secret_value=$("${OP_INSTALL_DIR}/op" read "$ref")
+  secret_value=$(op read $ref)

  if [ -z "$secret_value" ]; then
    echo "Could not find or access secret $ref"
@@ -92,7 +67,7 @@ populating_secret() {
    # To support multiline secrets, we'll use the heredoc syntax to populate the environment variables.
    # As the heredoc identifier, we'll use a randomly generated 64-character string,
    # so that collisions are practically impossible.
-    random_heredoc_identifier=$(openssl rand -hex 32)
+    random_heredoc_identifier=$(openssl rand -hex 16)

    {
      # Populate env var, using heredoc syntax with generated identifier
@@ -116,7 +91,7 @@ populating_secret() {
 # and make them available as environment variables in the next steps.
 extract_secrets() {
  IFS=$'\n'
-  for env_var in $("${OP_INSTALL_DIR}/op" env ls); do
+  for env_var in $(op env ls); do
    populating_secret $env_var
  done
 }
@@ -137,7 +112,6 @@ printf "Authenticated with %s \n" $auth_type
 unset_prev_secrets
 install_op_cli
 extract_secrets
-uninstall_op_cli

 unset IFS
 # Add extra env var that lists which secrets are managed by 1Password so that in a later step
--- a/package-lock.json
+++ b/package-lock.json
--- a/package.json
+++ b/package.json
@@ -1,66 +1,37 @@
 {
-	"name": "load-secrets-action",
-	"version": "1.2.0",
-	"description": "Load Secrets from 1Password",
-	"type": "module",
-	"main": "dist/index.js",
-	"directories": {
-		"test": "tests"
-	},
-	"scripts": {
-		"build": "ncc build ./src/index.ts",
-		"format": "prettier --ignore-path ./config/.prettierignore",
-		"format:check": "npm run format -- --check ./",
-		"format:write": "npm run format -- --write ./",
-		"lint": "eslint ./",
-		"lint:fix": "npm run lint -- --fix",
-		"prepare": "husky install ./config/.husky",
-		"test": "jest --config=./config/jest.config.js",
-		"test:clearcache": "jest --clearCache",
-		"test:coverage": "npm run test -- --coverage",
-		"test:watch": "npm run test -- --watch",
-		"typecheck": "tsc",
-		"validate": "npm run format:check && npm run lint && npm run test:coverage && npm run typecheck && npm run build"
-	},
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/1Password/load-secrets-action.git"
-	},
-	"keywords": [
-		"actions",
-		"1password",
-		"load secrets",
-		"connect"
-	],
-	"author": "1Password",
-	"license": "MIT",
-	"bugs": {
-		"url": "https://github.com/1Password/load-secrets-action/issues"
-	},
-	"homepage": "https://github.com/1Password/load-secrets-action#readme",
-	"dependencies": {
-		"@actions/core": "^1.10.0",
-		"@actions/exec": "^1.1.1"
-	},
-	"devDependencies": {
-		"@1password/front-end-style": "^6.0.1",
-		"@types/jest": "^29.5.0",
-		"@types/node": "^18.15.10",
-		"@vercel/ncc": "^0.36.1",
-		"husky": "^8.0.3",
-		"jest": "^29.5.0",
-		"lint-staged": "^13.2.0",
-		"ts-jest": "^29.0.5",
-		"typescript": "^4.9.5"
-	},
-	"eslintConfig": {
-		"extends": "./node_modules/@1password/front-end-style/eslintrc.yml",
-		"ignorePatterns": [
-			"coverage/"
-		],
-		"parserOptions": {
-			"project": "./tsconfig.json"
-		}
-	},
-	"prettier": "./node_modules/@1password/front-end-style/prettierrc.json"
+  "name": "load-secrets-action",
+  "version": "1.1.0",
+  "description": "Load Secrets from 1Password",
+  "main": "dist/index.js",
+  "directories": {
+    "test": "tests"
+  },
+  "scripts": {
+    "build": "ncc build src/index.ts"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/1Password/load-secrets-action.git"
+  },
+  "keywords": [
+    "actions",
+    "1password",
+    "load secrets",
+    "connect"
+  ],
+  "author": "1Password",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/1Password/load-secrets-action/issues"
+  },
+  "homepage": "https://github.com/1Password/load-secrets-action#readme",
+  "dependencies": {
+    "@actions/core": "^1.9.1",
+    "@actions/exec": "^1.1.1"
+  },
+  "devDependencies": {
+    "@types/node": "^18.7.14",
+    "@vercel/ncc": "^0.34.0",
+    "typescript": "^4.8.2"
+  }
 }
--- a/src/index.ts
+++ b/src/index.ts
@@ -1,32 +1,21 @@
-import path from "path";
-import url from "url";
-import * as core from "@actions/core";
-import * as exec from "@actions/exec";
+import * as core from '@actions/core';
+import * as exec from '@actions/exec';
+import path from 'path';

-const run = async () => {
-	try {
-		const currentFile = url.fileURLToPath(import.meta.url);
-		const currentDir = path.dirname(currentFile);
-		const parentDir = path.resolve(currentDir, "..");
+async function run(): Promise<void> {
+  try {
+    const parentDir = path.resolve(__dirname, '..');
+    
+    // Get action inputs
+    process.env.INPUT_UNSET_PREVIOUS = core.getInput('unset-previous');
+    process.env.INPUT_EXPORT_ENV = core.getInput('export-env');

-		// Get action inputs
-		process.env.INPUT_UNSET_PREVIOUS = core.getInput("unset-previous");
-		process.env.INPUT_EXPORT_ENV = core.getInput("export-env");
+    // Execute bash script
+    await exec.exec(`sh -c "` + parentDir + `/entrypoint.sh"`);

-		// Execute bash script
-		await exec.exec(`sh -c "` + parentDir + `/entrypoint.sh"`);
-	} catch (error) {
-		// It's possible for the Error constructor to be modified to be anything
-		// in JavaScript, so the following code accounts for this possibility.
-		// https://kentcdodds.com/blog/get-a-catch-block-error-message-with-typescript
-		let message = "Unknown Error";
-		if (error instanceof Error) {
-			message = error.message;
-		} else {
-			String(error);
-		}
-		core.setFailed(message);
-	}
-};
+  } catch (error: any) {
+    core.setFailed(error.message);
+  }
+}

-void run();
+run();
--- a/tsconfig.json
+++ b/tsconfig.json
@@ -1,25 +1,13 @@
 {
-	"compilerOptions": {
-		"allowJs": false,
-		"allowUnreachableCode": false,
-		"allowUnusedLabels": false,
-		"esModuleInterop": true,
-		"exactOptionalPropertyTypes": true,
-		"forceConsistentCasingInFileNames": true,
-		"importsNotUsedAsValues": "error",
-		"isolatedModules": true,
-		"module": "esnext",
-		"moduleResolution": "node",
-		"noEmit": true,
-		"noEmitOnError": true,
-		"noFallthroughCasesInSwitch": true,
-		"noImplicitReturns": true,
-		"noUncheckedIndexedAccess": true,
-		"noUnusedLocals": true,
-		"noUnusedParameters": true,
-		"outDir": "./dist/",
-		"rootDir": "./src/",
-		"strict": true,
-		"target": "es2022"
-	}
+    "compilerOptions": {
+        "target": "es6",
+        "module": "commonjs",
+        "moduleResolution": "node",
+        "outDir": "./dist",
+        "rootDir": "./src",
+        "strict": true,
+        "noImplicitAny": true,
+        "esModuleInterop": true
+    },
+    "exclude": ["node_modules"]
 }
Author	SHA1	Message	Date
Lucy Butcher	ea085fcce0	Added basic usage examples to readme Some checks failed Run acceptance tests / use-connect-without-export-env (push) Has been cancelled Details Run acceptance tests / use-connect-with-export-env (push) Has been cancelled Details Run acceptance tests / use-connect-with-references-with-id (push) Has been cancelled Details Run acceptance tests / use-service-account-without-export-env (push) Has been cancelled Details Run acceptance tests / use-service-account-with-export-env (push) Has been cancelled Details Run acceptance tests / use-service-account-with-references-with-id (push) Has been cancelled Details Run acceptance tests / run-on-macos-12 (push) Has been cancelled Details	2022-10-18 09:03:48 -04:00
Lucy Butcher	85386695a5	Update readme to link to developer portal This MR updates the readme to: - Match the final edited text used in the developer portal - Link out to the developer portal for usage examples beyond basic setup	2022-10-03 09:26:54 -04:00