This boilerplate contains some basic workflows to build, lint and test your code.
The workflows are designed for Github Actions
and will work out of the box with almost zero-configuration.
Feel free to adjust the workflows to your own requirements, you can find all of the workflows in the directory: .github
To ensure code quality it's a common practice to create a set of rules that will apply to the main
branch.
It's highly recommended that you only submit your code by using pull request and never push directly into the main
branch.
To automate the release process, we will be using the GitHub bots and they are also affected by these rules. Below I will describe the workaround, we are going to give the bot administrator privileges so it will be able to bypass all of the rule sets.
- As administrator, create a classic Personal Access Token with "repo" rights
- Now go to your repository
- Click on Settings
- Click on: Secrets and variables -> Actions
- Now click on the button: "New repository secret"
- Configure the name as:
PAT
, copy your generated token and set expiration time - Under Actions -> release, you will see the button: "Run workflow" this will start the release on the CI
Alternatively you can also create manually releases by using pnpm release --no-ci
in this case it will use your local machine git variables and tokens.