Skip to content

Commit 5730936

Browse files
committed
docs: Fix testing section to remove npm references
- Remove incorrect npm test/lint commands (we don't use npm) - Add proper testing instructions using act or GitHub Actions - Add example workflow for testing in user repositories - Clarify that this is a composite action using bash scripts The actions are tested via GitHub Actions CI, not npm tests.
1 parent 4b20d78 commit 5730936

File tree

1 file changed

+26
-4
lines changed

1 file changed

+26
-4
lines changed

README.md

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -183,11 +183,33 @@ We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) f
183183
git clone https://github.com/StacklokLabs/toolhive-actions.git
184184
cd toolhive-actions
185185
186-
# Run tests
187-
npm test
186+
# Test the actions locally using act (https://github.com/nektos/act)
187+
act -W .github/workflows/test.yml
188188
189-
# Run linting
190-
npm run lint
189+
# Or push to a branch and let GitHub Actions run the tests
190+
git checkout -b test-branch
191+
git push origin test-branch
192+
```
193+
194+
### Testing in Your Own Workflow
195+
196+
To test these actions in your own repository:
197+
198+
```yaml
199+
name: Test Toolhive Actions
200+
on: [push, pull_request]
201+
202+
jobs:
203+
test:
204+
runs-on: ubuntu-latest
205+
steps:
206+
- uses: actions/checkout@v4
207+
208+
- name: Install Toolhive
209+
uses: StacklokLabs/toolhive-actions/install@v0
210+
211+
- name: Verify installation
212+
run: thv version
191213
```
192214

193215
## 📄 License

0 commit comments

Comments
 (0)