This is a template for GitHub Actions with TypeScript.
- Click
"Use this template"
button on GitHub (https://github.com/mysticatea-actions/template). - Input the information of your new reporsitory then click
"Create repository from template"
button. - Update
package.json
file with the correct fields of name, description, repository, author, bugs, and homepage. - Update
LICENSE
file with your license. - Update
README.md
file. - Start to develop.
<root>
├ dist ... Built result.
├ lib ... Source code.
├ scripts ... Development tools.
└ test ... Test code.
npm test
... Run tests.npm version <how>
... Bump a version and release it. The<how>
is one ofpatch
,minor
,major
, and etc. See https://docs.npmjs.com/cli/version for details. This will do the following steps:- Check the code with ESLint and TypeScript compiler.
- Run tests.
- Bump version.
- Build the code.
- Release it with scripts/release.ts script.
npm run build
... Build code then createdist
directory.