Skip to content

Commit a724bae

Browse files
authored
Merge pull request #4 from sourcetoad/pmw-41-readme-development-update
PMW-41 Readme development steps update
2 parents 83ccd2e + 4d73523 commit a724bae

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,5 +36,22 @@ Path at which socket was created.
3636
run: ls -l "${{ steps.ssh-socket-action.outputs.socket-path }}"
3737
3838
## Development
39+
Make `ncc` available in your build environment:
40+
41+
npm i -g @zeit/ncc
42+
43+
Install package dependencies:
44+
3945
yarn install
46+
47+
Build `dist/index.js`:
48+
4049
ncc build index.js
50+
51+
### Install as Local Action
52+
For quicker troubleshooting cycles, the action can be copied directly into another project. This way, changes to the action and it's usage can happen simultaneously, in one commit.
53+
54+
1. Copy this repository into your other project as `.github/actions/ssh-socket-action`. Be careful: simply cloning in place will likely install it as a submodule--make sure to copy the files without `.git`
55+
2. In your other project's workflow, in the action step, set\
56+
`uses: ./.github/actions/ssh-socket-action`
57+
3. When making changes to the local action, make sure to rebuild `dist` and commit it

0 commit comments

Comments
 (0)