Skip to content

Commit f365dbd

Browse files
committed
Change development policy to repackaging on every code change
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.
1 parent 7e1d12d commit f365dbd

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

.github/CONTRIBUTING.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -41,24 +41,27 @@ npm run test
4141

4242
See the [official Github documentation][pat-docs] to learn more about Personal Access Tokens.
4343

44-
### 6. Commit
44+
### 6. Build
45+
46+
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:
47+
48+
```
49+
npm run build
50+
npm run pack
51+
```
52+
53+
### 7. Commit
4554

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

4857
Thanks!
4958

5059
## Release workflow
5160

52-
1. `npm install` to add all the dependencies, included development.
53-
1. `npm run build` to build the Action under the `./lib` folder.
54-
1. `npm run test` to see everything works as expected.
55-
1. `npm run pack` to package for distribution
56-
1. `git add src dist` to check in the code that matters.
57-
1. If the release will increment the major version, update the action refs in the examples in README.md
58-
(e.g., `uses: arduino/arduino-lint-action@v1` -> `uses: arduino/arduino-lint-action@v2`).
59-
1. open a PR and request a review.
60-
1. After PR is merged, create a release, following the `vX.X.X` tag name convention.
61-
1. After the release, rebase the release branch for that major version (e.g., `v1` branch for the v1.x.x tags) on the
62-
tag. If no branch exists for the release's major version, create one.
61+
Instructions for releasing a new version of the action:
62+
63+
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`).
64+
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/).
65+
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.
6366

6467
[pat-docs]: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token

0 commit comments

Comments
 (0)