actions/ssh-agent
1
0
Fork 0
mirror of https://github.com/webfactory/ssh-agent.git synced 2025-06-28 05:33:45 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

[DOC] Update readme with section about exported variables

Browse source
This commit is contained in:
Thorben Nissen 2020-04-10 20:45:21 +02:00
parent 0e6fdec538
commit bf9b7d9686
1 changed files with 14 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -57,6 +57,20 @@ The `ssh-agent` will load all of the keys and try each one in order when establi
There's one **caveat**, though: SSH servers may abort the connection attempt after a number of mismatching keys have been presented. So if, for example, you have There's one **caveat**, though: SSH servers may abort the connection attempt after a number of mismatching keys have been presented. So if, for example, you have
six different keys loaded into the `ssh-agent`, but the server aborts after five unknown keys, the last key (which might be the right one) will never even be tried. six different keys loaded into the `ssh-agent`, but the server aborts after five unknown keys, the last key (which might be the right one) will never even be tried.
## Exported variables
The action exports `SSH_AUTH_SOCK` and `SSH_AGENT_PID` through the Github Actions core module.
The `$SSH_AUTH_SOCK` is used by several applications like git or rsync to connect to the SSH authentication agent.
The `$SSH_AGENT_PID` can be used to kill the SSH agent, e.g. when using on a self-hosted runner:
```yaml
jobs:
job_1:
steps:
# ...
- name: Stop SSH agent
run: kill $SSH_AGENT_PID
```
The variables are only available inside the current job.
## Known issues and limitations ## Known issues and limitations
### Currently OS X and Linux only ### Currently OS X and Linux only