A template for new open source libraries written in TypeScript.
First, create a new repository based on this template by clicking the green Use this template button on the GitHub repository homepage. Clone your new repository and run this in a terminal:
$ ./init.sh
- GitHub configuration is updated automatically if you install the Settings app
- PR's are merged automatically if you install probot-auto-merge
- Monitor the code quality with
CodeClimate. Replace
<code_climate_reporter_id>
in.github/workflows/ci.yaml
with the Test Reporter ID obtained from CodeClimate (navigate to Repo Settings > Test coverage). - Auto-release by using
semantic-release.
Create these repository secrets:
NPM_TOKEN
: Enter a NPM access token with Read and Publish permission to publish your package to NPM.GH_TOKEN
: Enter a GitHub Personal Acces Token with repo permission. This is needed to circumvent branch protection rules when adding release commits.
Done! ๐