-
-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
50 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
# Contributing | ||
|
||
## General | ||
|
||
A good general description on how to develop a GitHub JavaScript action can be found [here](https://docs.github.com/en/actions/creating-actions/creating-a-javascript-action). | ||
|
||
## Developing locally | ||
|
||
### Prerequisites | ||
|
||
- Node 20 | ||
|
||
### Installing dependencies | ||
|
||
`npm install` | ||
|
||
### Building the action | ||
|
||
`npm run build` | ||
|
||
Updates the contents of the `dist` folder, which then _needs to be committed_. | ||
|
||
### Formatting source files | ||
|
||
`npm run format` | ||
|
||
### Checking formatting of source files | ||
|
||
`npm run format-check` | ||
|
||
### Linting source files | ||
|
||
`npm run lint` | ||
|
||
### Running tests | ||
|
||
`npm run test` | ||
|
||
### Running all of the above sequentially | ||
|
||
`npm run all` | ||
|
||
## Adding a new input parameter | ||
|
||
The following places need to be updated | ||
|
||
- action.yml | ||
- src/main.ts (`getCheckReleaseArguments()`) | ||
- dist/index.js (automatically generated) | ||
- README.md |