development.md

Development

This document contains notes for how to develop this library.

Building the distributed code for this Action

As is common for Actions, this repository contains the distributed code for this Action in the dist directory. As a result, any change to a file in src or to package.json must also be accompanied by manual compilation. This should be done with the following command:

npm run all

The result of that command (changes to the dist directory and other generated files) should be included in the same commit that changes the source.

Regenerating the Typescript interface for the configuration schema

The configuration JSON schema acts as the source of truth for the configuration file format that this workflow accepts: each change to configuration should begin with a change to that schema. Once that change has been made, we should regenerate the corresponding Configuration interface in Typescript using the generate:config script:

npm run generate:config