From 2d74546fd1520e88a6e7a37bba0be15f38002946 Mon Sep 17 00:00:00 2001 From: Bolaji Olajide <25608335+BolajiOlajide@users.noreply.github.com> Date: Sun, 21 Dec 2025 05:41:19 +0100 Subject: [PATCH 1/3] docs: add SSH key format parameter documentation --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index c95ebda..faa3067 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,21 @@ Specify in your workflow YAML file which secrets from 1Password should be loaded Read more on the [1Password Developer Portal](https://developer.1password.com/docs/ci-cd/github-actions). +## 🔑 SSH Key Format + +When loading SSH keys, you can specify the format using the `ssh-format` query parameter. This is useful when you need the private key in a specific format like OpenSSH. + +```yml +- name: Load SSH key + uses: 1password/load-secrets-action@v3 + env: + OP_SERVICE_ACCOUNT_TOKEN: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }} + # Load SSH private key in OpenSSH format + SSH_PRIVATE_KEY: op://vault/item/private key?ssh-format=openssh +``` + +For more details on secret reference syntax, see the [1Password CLI documentation](https://developer.1password.com/docs/cli/secret-reference-syntax/#ssh-format-parameter). + ## 🪄 See it in action! [![Using 1Password Service Accounts with GitHub Actions - showcase](https://img.youtube.com/vi/kVBl5iQYgSA/maxresdefault.jpg)](https://www.youtube.com/watch?v=kVBl5iQYgSA "Using 1Password Service Accounts with GitHub Actions") From b91fef0861b4cf6f8b7c7ac44c3209b90d88b90b Mon Sep 17 00:00:00 2001 From: Bolaji Olajide <25608335+BolajiOlajide@users.noreply.github.com> Date: Mon, 22 Dec 2025 16:33:55 +0100 Subject: [PATCH 2/3] move section to quoickstart --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index faa3067..1658bca 100644 --- a/README.md +++ b/README.md @@ -17,19 +17,6 @@ Specify in your workflow YAML file which secrets from 1Password should be loaded Read more on the [1Password Developer Portal](https://developer.1password.com/docs/ci-cd/github-actions). -## 🔑 SSH Key Format - -When loading SSH keys, you can specify the format using the `ssh-format` query parameter. This is useful when you need the private key in a specific format like OpenSSH. - -```yml -- name: Load SSH key - uses: 1password/load-secrets-action@v3 - env: - OP_SERVICE_ACCOUNT_TOKEN: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }} - # Load SSH private key in OpenSSH format - SSH_PRIVATE_KEY: op://vault/item/private key?ssh-format=openssh -``` - For more details on secret reference syntax, see the [1Password CLI documentation](https://developer.1password.com/docs/cli/secret-reference-syntax/#ssh-format-parameter). ## 🪄 See it in action! @@ -86,6 +73,19 @@ jobs: # Prints: Secret: *** ``` +### 🔑 SSH Key Format + +When loading SSH keys, you can specify the format using the `ssh-format` query parameter. This is useful when you need the private key in a specific format like OpenSSH. + +```yml +- name: Load SSH key + uses: 1password/load-secrets-action@v3 + env: + OP_SERVICE_ACCOUNT_TOKEN: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }} + # Load SSH private key in OpenSSH format + SSH_PRIVATE_KEY: op://vault/item/private key?ssh-format=openssh +``` + ## 💙 Community & Support - File an [issue](https://github.com/1Password/load-secrets-action/issues) for bugs and feature requests. From 13c259d353e223675fa00546f1bb168c6bb65fc1 Mon Sep 17 00:00:00 2001 From: Bolaji Olajide <25608335+BolajiOlajide@users.noreply.github.com> Date: Mon, 22 Dec 2025 18:08:38 +0100 Subject: [PATCH 3/3] update --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1658bca..6a0ac5f 100644 --- a/README.md +++ b/README.md @@ -17,8 +17,6 @@ Specify in your workflow YAML file which secrets from 1Password should be loaded Read more on the [1Password Developer Portal](https://developer.1password.com/docs/ci-cd/github-actions). -For more details on secret reference syntax, see the [1Password CLI documentation](https://developer.1password.com/docs/cli/secret-reference-syntax/#ssh-format-parameter). - ## 🪄 See it in action! [![Using 1Password Service Accounts with GitHub Actions - showcase](https://img.youtube.com/vi/kVBl5iQYgSA/maxresdefault.jpg)](https://www.youtube.com/watch?v=kVBl5iQYgSA "Using 1Password Service Accounts with GitHub Actions") @@ -86,6 +84,8 @@ When loading SSH keys, you can specify the format using the `ssh-format` query p SSH_PRIVATE_KEY: op://vault/item/private key?ssh-format=openssh ``` +For more details on secret reference syntax, see the [1Password CLI documentation](https://developer.1password.com/docs/cli/secret-reference-syntax/#ssh-format-parameter). + ## 💙 Community & Support - File an [issue](https://github.com/1Password/load-secrets-action/issues) for bugs and feature requests.