Skip to content

Commit f6ba020

Browse files
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 2183ab8 commit f6ba020

File tree

1 file changed

+31
-12
lines changed

1 file changed

+31
-12
lines changed

README.md

Lines changed: 31 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -103,25 +103,43 @@ To run the tests:
103103
npm run test
104104
```
105105

106-
### 6. Commit
106+
### 6. Build
107+
108+
It is necessary to compile the code before it can be used by GitHub Actions. We check in the `node_modules` to provide runtime dependencies to the system using the Action, so be careful not to `git add` all the development dependencies you might have under your local `node_modules`.
109+
Remember to run these commands before committing any code changes:
110+
111+
```
112+
npm run build
113+
```
114+
115+
remove all the dependencies:
116+
117+
```
118+
rm -rf node_modules
119+
```
120+
121+
add back **only** the runtime dependencies:
122+
123+
```
124+
npm install --production
125+
```
126+
127+
check in the code that matters:
128+
129+
```
130+
git add lib node_modules
131+
```
132+
133+
### 7. Commit
107134

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

110137
Thanks!
111138

112139
## Release workflow
113140

114-
We check in the `node_modules` to provide runtime dependencies to the system
115-
using the Action, so be careful not to `git add` all the development dependencies
116-
you might have under your local `node_modules`. To release a new version of the
117-
Action the workflow should be the following:
118-
119-
1. `npm install` to add all the dependencies, included development.
120-
1. `npm run test` to see everything works as expected.
121-
1. `npm run build` to build the Action under the `./lib` folder.
122-
1. `rm -rf node_modules` to remove all the dependencies.
123-
1. `npm install --production` to add back **only** the runtime dependencies.
124-
1. `git add lib node_modules` to check in the code that matters.
141+
To release a new version of the Action the workflow should be the following:
142+
125143
1. If the release will increment the major version, update the action refs in the examples in README.md
126144
(e.g., `uses: arduino/setup-protoc@v1` -> `uses: arduino/setup-protoc@v2`).
127145
1. open a PR and request a review.
@@ -143,3 +161,4 @@ If you think you found a vulnerability or other security-related bug in this pro
143161
Thank you!
144162

145163
e-mail contact: security@arduino.cc
164+

0 commit comments

Comments
 (0)