CONTRIBUTING.md

Development workflow

1. Install dependencies

npm install

2. Coding

Now you're ready to work some TypeScript magic!

Make sure to write or update tests for your work when appropriate.

2. Format code

Format the code to follow the standard style for the project:

npm run format

3. Run tests

Run the tests to ensure that the code works as expected:

npm run test

4. Build

It is necessary to compile the code before it can be used by GitHub Actions. Remember to run these commands before committing any code changes:

npm run build
npm run pack

3. Commit

Everything is now ready to make your contribution to the project, so commit it to the repository and submit a pull request.

Thanks!

Enable verbose logging for a pipeline

Additional log events with the prefix ::debug:: can be enabled by setting the secret ACTIONS_STEP_DEBUG to true.

See step-debug-logs for reference.

Release workflow

Instructions for releasing a new version of the action:

1. If the release will increment the major version, update the action refs in the examples in README.md (e.g., uses: arduino/setup-taskfile@v1 -> uses: arduino/setup-taskfile@v2).
2. Create a GitHub release, following the vX.Y.Z tag name convention. Make sure to follow the SemVer specification.
3. Rebase the release branch for that major version (e.g., v1 branch for the v1.x.x tags) on the tag. If no branch exists for the release's major version, create one.