5 Commits

Author SHA1 Message Date
Matthias Pigulla
dc588b651f Update version numbers in the README examples 2024-02-06 10:28:20 +01:00
Kevin Glavin
204eb35a4e Bump to node20 (#201)
Fix for deprecated node16

Node.js 16 actions are deprecated. Please update the following actions
to use Node.js 20: webfactory/ssh-agent@v0.8.0. For more information
see:
https://github.blog/changelog/2023-09-22-github-actions-transitioning-from-node-16-to-node-20/
2024-02-06 10:26:21 +01:00
Felix Seifert
9f6f312a31 chore: update all versions of actions/checkout to v4 (#199)
In this PR, I update the `actions/checkout` versions. When I recently
started using this action, I was confused about whether it works with
the newest checkout action. I tested it and everything is fine. For
future users, we should display examples with the newest versions.
2024-02-06 09:38:02 +01:00
Benjamin Ragheb
2e59dd7d06 Remove outdated claim from README (#206)
Since #171 was merged, this action no longer touches `known_hosts`; this
line should have been removed from the README at that time.
2024-02-05 07:37:14 +01:00
wolf++
fd34b8dee2 Update README.md to reflect latest version (#196) 2023-11-02 17:03:13 +01:00
3 changed files with 13 additions and 13 deletions

View File

@@ -8,7 +8,7 @@ jobs:
os: [ ubuntu-latest, macOS-latest, windows-latest ]
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- name: Setup key
uses: ./
with:
@@ -28,7 +28,7 @@ jobs:
container:
image: ubuntu:latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- run: apt update && apt install -y openssh-client git
- name: Setup key
uses: ./

View File

@@ -1,10 +1,9 @@
# `ssh-agent` GitHub Action
This action
* starts the `ssh-agent`,
* exports the `SSH_AUTH_SOCK` environment variable,
* loads one or several private SSH key into the agent and
* configures `known_hosts` for GitHub.com.
This action
* starts the `ssh-agent`,
* exports the `SSH_AUTH_SOCK` environment variable, and
* loads one or several private SSH key into the agent.
It should work in all GitHub Actions virtual environments, including container-based workflows.
@@ -27,7 +26,7 @@ GitHub Actions only have access to the repository they run for. So, in order to
* In your repository, go to the *Settings > Secrets* menu and create a new secret. In this example, we'll call it `SSH_PRIVATE_KEY`.
* Put the contents of the *private* SSH key file into the contents field. <br>
* This key should start with `-----BEGIN ... PRIVATE KEY-----`, consist of many lines and ends with `-----END ... PRIVATE KEY-----`.
5. In your workflow definition file, add the following step. Preferably this would be rather on top, near the `actions/checkout@v2` line.
5. In your workflow definition file, add the following step. Preferably this would be rather on top, near the `actions/checkout@v4` line.
```yaml
# .github/workflows/my-workflow.yml
@@ -35,9 +34,9 @@ jobs:
my_job:
...
steps:
- uses: actions/checkout@v3
# Make sure the @v0.7.0 matches the current version of the action
- uses: webfactory/ssh-agent@v0.7.0
- uses: actions/checkout@v4
# Make sure the @v0.9.0 matches the current version of the action
- uses: webfactory/ssh-agent@v0.9.0
with:
ssh-private-key: ${{ secrets.SSH_PRIVATE_KEY }}
# ... other steps
@@ -52,7 +51,7 @@ You can set up different keys as different secrets and pass them all to the acti
```yaml
# ... contents as before
- uses: webfactory/ssh-agent@v0.7.0
- uses: webfactory/ssh-agent@v0.9.0
with:
ssh-private-key: |
${{ secrets.FIRST_KEY }}

View File

@@ -20,10 +20,11 @@ inputs:
description: 'git command'
required: false
runs:
using: 'node16'
using: 'node20'
main: 'dist/index.js'
post: 'dist/cleanup.js'
post-if: 'always()'
branding:
icon: loader
color: 'yellow'