actions/ssh-agent
1
0
Fork 0
mirror of https://github.com/webfactory/ssh-agent.git synced 2025-04-24 15:02:13 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

[DOC] Improve README

Browse source
This commit is contained in:
Thorben Nissen 2020-05-15 10:07:30 +02:00
parent b05960c6f2
commit 0d3af9e04f
1 changed files with 2 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -60,16 +60,7 @@ six different keys loaded into the `ssh-agent`, but the server aborts after five
## Exported variables ## Exported variables
The action exports `SSH_AUTH_SOCK` and `SSH_AGENT_PID` through the Github Actions core module. 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_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: The `$SSH_AGENT_PID` contains the process id of the agent. This is used to kill the agent in post job action.
```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
@ -130,7 +121,7 @@ As a note to my future self, in order to work on this repo:
* Run `npm install` to fetch dependencies * Run `npm install` to fetch dependencies
* _hack hack hack_ * _hack hack hack_
* `node index.js`. Inputs are passed through `INPUT_` env vars with their names uppercased. Use `env "INPUT_SSH-PRIVATE-KEY=\`cat file\`" node index.js` for this action. * `node index.js`. Inputs are passed through `INPUT_` env vars with their names uppercased. Use `env "INPUT_SSH-PRIVATE-KEY=\`cat file\`" node index.js` for this action.
* Run `npm run build` to update `dist/*`, which is the file actually run * Run `npm run build` to update `dist/*`, which holds the files actually run
* Read https://help.github.com/en/articles/creating-a-javascript-action if unsure. * Read https://help.github.com/en/articles/creating-a-javascript-action if unsure.
* Maybe update the README example when publishing a new version. * Maybe update the README example when publishing a new version.