2024-07-25 00:20:56 +02:00
# 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
2024-07-28 04:42:47 +02:00
### Logging in to GitHub package registry
1. Create a classic Personal Access Token (PAT) for your GitHub profile,
with permission `read:packages` :
https://github.com/settings/tokens
1. Use that token to log in to the registry:
`npm login --registry https://npm.pkg.github.com --scope @actions-rs`
Username: dummy
Password: \<paste your PAT here\>
This allows `@actions-rs` npm packages to be downloaded.
2024-07-25 00:20:56 +02:00
### 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
