Skip to content

Commit 2d70938

Browse files
PMW-41 - fix: add development steps to Readme
1 parent 5939438 commit 2d70938

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,25 @@
11
# SSH Socket Setup GitHub Action
22
Setup an SSH socket with a private key.
33

4-
## Inputs
5-
### `host`
4+
## Usage
5+
### Inputs
6+
#### `host`
67
**Required** Remote hostname
78

8-
### `socket-path`
9+
#### `socket-path`
910
**Required** Path at which to create socket.
1011

11-
### `key`
12+
#### `key`
1213
**Required** SSH private key
1314

14-
## Outputs
15-
### `socket-path`
15+
### Outputs
16+
#### `socket-path`
1617
Path at which socket was created.
1718

18-
## Example usage
19+
### Example usage
1920
- name: SSH Socket Setup
2021
id: ssh-socket-action
21-
uses: ./.github/actions/ssh-sock-setup
22+
uses: sourcetoad/ssh-sock-setup
2223
with:
2324
host: github.com
2425
socket-path: /tmp/ssh_agent.sock
@@ -27,3 +28,7 @@ Path at which socket was created.
2728
- name: Use SSH socket
2829
run: |
2930
ls -l "${{ steps.ssh-socket-action.outputs.socket-path }}"
31+
32+
## Development
33+
yarn install
34+
ncc build index.js

0 commit comments

Comments
 (0)