actions/cargo-semver-checks
actions/cargo-semver-checks
3
0
Fork 0
mirror of https://github.com/obi1kenobi/cargo-semver-checks-action.git synced 2024-11-21 07:39:32 +01:00
Code Issues Projects Activity Pipelines
cargo-semver-checks/CONTRIBUTING.md
Magnus Markling b4150892af
add npm login section to CONTRIBUTING.md (#89)
2024-07-27 22:42:47 -04:00

1.2 KiB
Raw Permalink Blame History

Contributing

General

A good general description on how to develop a GitHub JavaScript action can be found here.

Developing locally

Prerequisites

  • Node 20

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

  2. 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.

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