Skip to content

Commit

Permalink
Change development policy to repackaging on every code change
Browse files Browse the repository at this point in the history
The previous development policy was to only repackage on each release. This prevented contributors from doing casual
beta testing by simply referencing the action as `arduino/arduino-lint-action@main` in a workflow.
  • Loading branch information
MatteoPologruto authored and per1234 committed Oct 20, 2024
1 parent 6ecbca8 commit 51174a5
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,20 +116,28 @@ npm run test
See the [official Github documentation][pat-docs] to know more about Personal Access Tokens.
### 6. Commit
### 6. 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
```
### 7. Commit
Everything is now ready to make your contribution to the project, so commit it to the repository and submit a pull request.
Thanks!
## Release workflow
1. `npm install` to add all the dependencies, included development.
2. `npm run build` to build the Action under the `./lib` folder.
3. `npm run test` to see everything works as expected.
4. `npm run pack` to package for distribution
5. `git add src dist` to check in the code that matters.
6. open a PR and request a review.
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/arduino-lint-action@v1` -> `uses: arduino/arduino-lint-action@v2`).
1. Create a [GitHub release](https://docs.github.com/en/github/administering-a-repository/managing-releases-in-a-repository#creating-a-release), following the `vX.Y.Z` tag name convention. Make sure to follow [the SemVer specification](https://semver.org/).
1. 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.
[pat-docs]: https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token
Expand Down

0 comments on commit 51174a5

Please sign in to comment.