All notable changes to the ConfigDirector Code Scan action are documented here. The format follows Keep a Changelog, and versions follow Semantic Versioning. @v1 follows the latest 1.x release.
- The action runs the CLI version you asked for even when the repository's
.npmrcsetsmin-release-age. Before, the job failed in the step Find the CLI version to run until that version was old enough.
versiondefaults tolatest, the newest release of@configdirector/cli, which is published without-betafrom 0.11.0. A workflow that setsversion: betastays on 0.10.0-beta.1, the last beta; remove the line to keep getting new releases.
- When the repository's
.npmrcsetsmin-release-age, the action runs the newest CLI release that is old enough. With thebetadefault, the job failed in the step Find the CLI version to run until the newest beta was that old.
- The log shows which version of
@configdirector/clithe run used, as inThis run uses @configdirector/cli 0.10.0-beta.1., in the step Find the CLI version to run.
- The check and the upload run the same version of the CLI, even when a new version is published to the
versioninput's dist-tag while the action runs.
- The action runs
configdirector validateon every run, which fails the job when the code reads a key no config has, the old key of a renamed config, a config as the wrong type, a config that is not served to that kind of SDK, or an enum value the config does not allow. On a push to the repository's default branch, it then runsconfigdirector scan --upload, so the dashboard shows where each config is read and which configs no code reads; it uploads even whenvalidatefound a problem. - Inputs:
token(required),version(defaultbeta) for the@configdirector/cliversion or dist-tag,0.9.0-beta.1or later,working-directory(default.) for the directory that holdsconfigdirector.json,upload(defaultauto: on pushes to the default branch only;trueon every run,falsenever),context-lines(default2, from 0 to 5) andsnippets(defaulttrue;falseuploads no code). Anuploadorsnippetsvalue other than those listed fails the job before anything runs.