Skip to content

Commit f98c0c7

Browse files
committed
Move development documentation to CONTRIBUTING.md
This information is not of interest to those who only want to use the action, so it is not appropriate for the readme.
1 parent e567c92 commit f98c0c7

File tree

2 files changed

+29
-30
lines changed

2 files changed

+29
-30
lines changed

CONTRIBUTING.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## Development
2+
3+
To work on the codebase you have to install all the dependencies:
4+
5+
```sh
6+
# npm install
7+
```
8+
9+
To run the tests:
10+
11+
```sh
12+
# npm run test
13+
```
14+
15+
## Enable verbose logging for a pipeline
16+
Additional log events with the prefix ::debug:: can be enabled by setting the secret `ACTIONS_STEP_DEBUG` to `true`.
17+
18+
See [step-debug-logs](https://github.com/actions/toolkit/blob/master/docs/action-debugging.md#step-debug-logs) for reference.
19+
20+
## Release
21+
22+
To release a new version of the Action the workflow should be the following:
23+
24+
1. `npm install` to install the dependencies.
25+
1. `npm run test` to see everything works as expected.
26+
1. `npm run build` to build the Action under the `./lib` folder.
27+
1. `npm run pack` to package for distribution
28+
1. `git add src dist` to check in the code that matters.
29+
1. open a PR and request a review.

README.md

-30
Original file line numberDiff line numberDiff line change
@@ -57,33 +57,3 @@ If you think you found a vulnerability or other security-related bug in this pro
5757
Thank you!
5858

5959
e-mail contact: [email protected]
60-
61-
## Development
62-
63-
To work on the codebase you have to install all the dependencies:
64-
65-
```sh
66-
# npm install
67-
```
68-
69-
To run the tests:
70-
71-
```sh
72-
# npm run test
73-
```
74-
75-
## Enable verbose logging for a pipeline
76-
Additional log events with the prefix ::debug:: can be enabled by setting the secret `ACTIONS_STEP_DEBUG` to `true`.
77-
78-
See [step-debug-logs](https://github.com/actions/toolkit/blob/master/docs/action-debugging.md#step-debug-logs) for reference.
79-
80-
## Release
81-
82-
To release a new version of the Action the workflow should be the following:
83-
84-
1. `npm install` to install the dependencies.
85-
1. `npm run test` to see everything works as expected.
86-
1. `npm run build` to build the Action under the `./lib` folder.
87-
1. `npm run pack` to package for distribution
88-
1. `git add src dist` to check in the code that matters.
89-
1. open a PR and request a review.

0 commit comments

Comments
 (0)