Skip to content

Commit 51174a5

Browse files
MatteoPologrutoper1234
authored andcommitted
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 6ecbca8 commit 51174a5

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

README.md

+15-7
Original file line numberDiff line numberDiff line change
@@ -116,20 +116,28 @@ npm run test
116116
117117
See the [official Github documentation][pat-docs] to know more about Personal Access Tokens.
118118
119-
### 6. Commit
119+
### 6. Build
120+
121+
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:
122+
123+
```
124+
npm run build
125+
npm run pack
126+
```
127+
128+
### 7. Commit
120129
121130
Everything is now ready to make your contribution to the project, so commit it to the repository and submit a pull request.
122131
123132
Thanks!
124133
125134
## Release workflow
126135
127-
1. `npm install` to add all the dependencies, included development.
128-
2. `npm run build` to build the Action under the `./lib` folder.
129-
3. `npm run test` to see everything works as expected.
130-
4. `npm run pack` to package for distribution
131-
5. `git add src dist` to check in the code that matters.
132-
6. open a PR and request a review.
136+
Instructions for releasing a new version of the action:
137+
138+
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`).
139+
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/).
140+
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.
133141
134142
[pat-docs]: https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token
135143

0 commit comments

Comments
 (0)