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
[**npm**](https://www.npmjs.com/) is used for dependency management.
8
+
9
+
Follow the installation instructions here:<br />
10
+
https://nodejs.dev/en/download
11
+
12
+
### 2. Install dependencies
13
+
14
+
To work on the codebase you have to install all the dependencies:
15
+
16
+
```
17
+
npm install
18
+
```
19
+
20
+
### 3. Coding
21
+
22
+
Now you're ready to work some [TypeScript](https://www.typescriptlang.org/) magic!
23
+
24
+
Make sure to write or update tests for your work when appropriate.
25
+
26
+
### 4. Format code
27
+
28
+
Format the code to follow the standard style for the project:
29
+
30
+
```
31
+
npm run format
32
+
```
33
+
34
+
### 5. Run tests
35
+
36
+
To run the tests:
37
+
38
+
```
39
+
npm run test
40
+
```
41
+
42
+
### 6. Build
43
+
44
+
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`.
45
+
Remember to run these commands before committing any code changes:
46
+
47
+
```
48
+
npm run build
49
+
```
50
+
51
+
remove all the dependencies:
52
+
53
+
```
54
+
rm -rf node_modules
55
+
```
56
+
57
+
add back **only** the runtime dependencies:
58
+
59
+
```
60
+
npm install --production
61
+
```
62
+
63
+
check in the code that matters:
64
+
65
+
```
66
+
git add lib node_modules
67
+
```
68
+
69
+
### 7. Commit
70
+
71
+
Everything is now ready to make your contribution to the project, so commit it to the repository and submit a pull request.
72
+
73
+
Thanks!
74
+
75
+
## Release workflow
76
+
77
+
To release a new version of the Action the workflow should be the following:
78
+
79
+
1. If the release will increment the major version, update the action refs in the examples in README.md
This action makes the `protoc` compiler available to Workflows.
15
16
@@ -28,7 +29,7 @@ If you want to pin a major or minor version you can use the `.x` wildcard:
28
29
- name: Install Protoc
29
30
uses: arduino/setup-protoc@v1
30
31
with:
31
-
version: '3.x'
32
+
version: "3.x"
32
33
```
33
34
34
35
You can also require to include releases marked as `pre-release` in Github using the `include-pre-releases` flag (the dafault value for this flag is `false`)
@@ -37,7 +38,7 @@ You can also require to include releases marked as `pre-release` in Github using
37
38
- name: Install Protoc
38
39
uses: arduino/setup-protoc@v1
39
40
with:
40
-
version: '3.x'
41
+
version: "3.x"
41
42
include-pre-releases: true
42
43
```
43
44
@@ -47,7 +48,7 @@ To pin the exact version:
47
48
- name: Install Protoc
48
49
uses: arduino/setup-protoc@v1
49
50
with:
50
-
version: '3.9.1'
51
+
version: "3.9.1"
51
52
```
52
53
53
54
The action queries the GitHub API to fetch releases data, to avoid rate limiting,
@@ -60,54 +61,22 @@ pass the default token with the `repo-token` variable:
60
61
repo-token: ${{ secrets.GITHUB_TOKEN }}
61
62
```
62
63
63
-
64
-
## Development
65
-
66
-
To work on the codebase you have to install all the dependencies:
67
-
68
-
```sh
69
-
# npm install
70
-
```
71
-
72
-
To run the tests:
73
-
74
-
```sh
75
-
# npm run test
76
-
```
77
-
78
64
## Enable verbose logging for a pipeline
65
+
79
66
Additional log events with the prefix ::debug:: can be enabled by setting the secret `ACTIONS_STEP_DEBUG` to `true`.
80
67
81
68
See [step-debug-logs](https://github.com/actions/toolkit/blob/master/docs/action-debugging.md#step-debug-logs) for reference.
82
69
83
-
84
-
85
-
## Release
86
-
87
-
We check in the `node_modules` to provide runtime dependencies to the system
88
-
using the Action, so be careful not to `git add` all the development dependencies
89
-
you might have under your local `node_modules`. To release a new version of the
90
-
Action the workflow should be the following:
91
-
92
-
1. `npm install` to add all the dependencies, included development.
93
-
1. `npm run test` to see everything works as expected.
94
-
1. `npm run build` to build the Action under the `./lib` folder.
95
-
1. `rm -rf node_modules` to remove all the dependencies.
96
-
1. `npm install --production` to add back **only** the runtime dependencies.
97
-
1. `git add lib node_modules` to check in the code that matters.
98
-
1. If the release will increment the major version, update the action refs in the examples in README.md
0 commit comments