Skip to content

Commit ee1b5ae

Browse files
authored
docs: Add notes about developing.
1 parent fe402b2 commit ee1b5ae

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

docs/how-to-develop.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# How to Develop
2+
3+
1. Open this project using the dev container config.
4+
1. Make your changes. Build into the `dist` folder using `npm run bundle`.
5+
1. Verify all tests run, either in the VS Code test runner or by running
6+
`npm test` in the terminal.
7+
1. Try running using the workflows in the `examples` folder.
8+
1. Verify the workflows run in `.github/workflows` using the `act` tool.
9+
- Check formatting:
10+
`act pull_request -W .github/workflows/linter.yml`
11+
- Check the build matches with source:
12+
`act pull_request -W .github/workflows/check-dist.yml`
13+
- Check that all tests pass:
14+
`act pull_request -W .github/workflows/ci.yml`
15+
- Use CodeQL to check for security vulnerabilities:
16+
`act pull_request -W .github/workflows/codeql-analysis.yml`
17+
1. Update version in `package.json`.
18+
1. Merge to `main`. Create a release with same tag as `package.json` version.
19+
1. Update the major version tag.
20+
21+
## Setup Nektos/Act
22+
23+
```bash
24+
# .actrc
25+
--var-file .act.vars
26+
--secret-file=.act.secrets
27+
--action-offline-mode
28+
--container-architecture=linux/amd64
29+
```

0 commit comments

Comments
 (0)