Skip to content

Commit 4d73523

Browse files
PMW-41 - docs: add steps for local installation
1 parent 8e21971 commit 4d73523

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,11 @@ Install package dependencies:
4747
Build `dist/index.js`:
4848

4949
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)