Update Credits
Refresh the credits in your README.md from nova.config.json.
Summary
The update-credits recipe rewrites the credits of a README.md file so the funding links and contributor acknowledgements stay in sync with nova.config.json. It reuses the exact builder the generate must-haves read-me command uses, so the spliced credits are byte-identical to a freshly generated region.
The recipe only touches the marked region. Everything before the <!-- nova-region: credits --> marker and everything after the <!-- nova-region-end: credits --> marker is left byte-identical, so hand-written prose around the credits is never disturbed.
Prerequisites
- An existing
README.md— The recipe updates a file in the project root; it does not create one. Usegenerate must-haves read-meto create the initial file. - The
creditsregion markers — TheREADME.mdmust contain the<!-- nova-region: credits -->and<!-- nova-region-end: credits -->markers. Agenerate must-haves read-mefile has them by default. - Credit inputs — At least one
urls.fundSourcesentry, or anentitiesentry with acontributororsupporterrole, innova.config.jsonso there are credits to render.
Behavior
The recipe follows an in-place splice so it can only ever rewrite the region it owns.
- Region gate — The
creditsregion markers must both be present and correctly ordered. If the markers are absent, misordered, or theREADME.mdwas not generated by Nova, the recipe warns that the region markers were not found and returns without writing. - Region-only splice — Only the content between the markers is replaced. The markers and all content outside them are preserved exactly.
- Not applicable — When the current
nova.config.jsonyields no credits, the recipe warns and returns without touching the file. - Idempotent — When the regenerated credits already match the file on disk, the recipe reports that the credits are already up to date and makes no write.
Settings
Settings are configured in nova.config.json under the recipes.read-me key. The update-credits recipe is controlled by a single enabled toggle:
{
"recipes": {
"read-me": {
"update-credits": {
"enabled": true
}
}
}
}
When the recipe is not enabled, it warns and returns without touching any files.
Usage
Options
| Flag | Description |
|---|---|
-d, --dry-run | Run without writing any files. |
-r, --replace-file | Replace the original file without creating a backup. |