You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Copy file name to clipboardExpand all lines: README.md
+31-12Lines changed: 31 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -103,25 +103,43 @@ To run the tests:
103
103
npm run test
104
104
```
105
105
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
107
134
108
135
Everything is now ready to make your contribution to the project, so commit it to the repository and submit a pull request.
109
136
110
137
Thanks!
111
138
112
139
## Release workflow
113
140
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
+
125
143
1. If the release will increment the major version, update the action refs in the examples in README.md
0 commit comments