Please read the following document.
Install cmdx by aqua.
aqua i -lThis project depends on Node.js, and there are a lot of Node.js version managers. This project supports a lot of Node.js version managers.
- aqua: aqua/node.yaml
- NVM: .nvmrc
- .node-version: https://github.com/shadowspawn/node-version-usage
- asdf, mise, fnm, nodeenv, etc
- volta: package.json
These versions must be same.
We manage Node.js packages using npm, not yarn and pnpm.
We don't manage transpiled JavaScript files in the main branch and feature branches.
dist directory is added in pr/<pr number> and releases automatically by CI.
You don't have to build TypeScript and commit JavaScript.
Coming soon.
cmdx fmtWe provide some automatic tests such as unit tests, but sometimes the automatic tests aren't enough so you have to test your changes on your environment. You have to build GitHub Actions workflows with this action and test your changes on the workflows.
When a pull request is created or updated, the branch pr/<pull request number> is also created or updated by GitHub Actions.
- https://github.com/suzuki-shunsuke/lock-action/actions/workflows/create-pr-branch.yaml
- https://github.com/suzuki-shunsuke/lock-action/blob/main/.github/workflows/create-pr-branch.yaml
Warning
These branches aren't created and updated against pull requests from fork repositories. Maintainers have to run the workflow manually.
You can test your pull request version by pr/<pull request number>.
For example, if you want to test the pull request #3,
you can update this action's version of your workflows to pr/3.
e.g.
- uses: suzuki-shunsuke/lock-action@pr/3