closes #6

⚠️ Breaking Change

Features

CI-Aware

markdown-inject is now CI-aware! It will exits with code 1 without writing new blocks when CI=true and block changes exist. This behavior can be bypassed with the --force-write (-f) flag. I've added a CI step to perform this validation internally.

Prepare: build

The build npm script now occurs on prepare for lazier local development. This is / can be bypassed with CI=true, meaning a CI build step that is separate from the install step is still necessary. This is intentional to ease isolating CI-time build failures.

Validation

Automated

I've added a Check Markdown Docs step to CI, which you can observe (intentionally) failing here:

https://github.com/target/markdown-inject/runs/3906606163

Also, note that no build occurs during the Install Dependencies step.

Manual

Due to the addition to the prepare script, installing dependencies will now cause a build to occur:

npm ci

Alternatively, setting CI=true will prevent this build:

CI=true npm ci

Let's write a junk markdown block to validate some things:

echo '<!-- CODEBLOCK_START {"type": "command", "value": "echo It is currently $(date)"} -->\n<!-- CODEBLOCK_END -->' > pr-17-test.md

Let's make sure we can still write markdown normally:

npm run markdown-inject

Now, let's re-write the empty block and try to write it with CI=true. The failure is expected, and the error text indicates that (1) block changes do not occur; (2) block changes are prohibited in CI; and (3) this can be bypassed with the --force-write CLI flag.

echo '<!-- CODEBLOCK_START {"type": "command", "value": "echo It is currently $(date)"} -->\n<!-- CODEBLOCK_END -->' > pr-17-test.md

CI=true npm run markdown-inject

Let's put that CLI flag to the test:

CI=true npm run markdown-inject -- --force-write

ℹ️ The extra -- before --force-write is because we call markdown-inject inside this repo with an npm script, and need to pass the arguments over npm so they are provided to the script itself.