✨ New Features
Manifest File Generation
Boilerplate can now produce a manifest file that records every file generated during a run, along with SHA256 checksums. Enable it with the new --manifest flag:
boilerplate \
--template-url ./templates/service \
--output-folder ./output \
--non-interactive \
--manifestThis creates a boilerplate-manifest.yaml in the output directory containing:
- File inventory — every generated file with its relative path and sha256: checksum
- Source checksum — a checksum of the template source (git commit SHA or directory hash)
- Variables & dependencies — the resolved variable values and dependency tree used during the run
- Schema version — a URL pointing to a published https://boilerplate.gruntwork.io/schemas/manifest/v1/schema.json for easy validation
The manifest format is auto-detected from the file extension: .json produces JSON, everything else produces YAML. To write to a custom path, use --manifest-file:
boilerplate \
--template-url ./templates/service \
--output-folder ./output \
--non-interactive \
--manifest-file ./reports/manifest.jsonThis is useful for auditing which files came from a template, drift detection by comparing checksums after the fact, and CI/CD pipelines that need to programmatically consume the list of generated files in downstream steps.
See https://boilerplate.gruntwork.io/advanced/manifest/ for details.
Exported validation Package
The validation package is now exported directly, so consumers of Boilerplate as a library can import validation instead of relying on the re-export through the variables package.
📖 Documentation Updates
- Added a docs homepage, Windows support page, and terminology page
- Fixed miscellaneous docs bugs
🧹 Chores
- Removed CircleCI configuration
- Fixed tests to avoid relying on the current branch existing in the remote
What's Changed
- feat: Adding manifest by @yhakbar in #285
- docs: Docs homepage, add Windows support and terminology pages by @josh-padnick in #278
- docs: Fixing docs bugs by @yhakbar in #286
- chore: Remove CircleCI by @josh-padnick in #279
- chore: Exporting
validationby @yhakbar in #287 - chore: Avoid relying on the current branch existing in remote for tests by @yhakbar in #288
Full Changelog: v0.12.1...v0.13.0