Skip to content

v0.27.0

Latest
Compare
Choose a tag to compare
@JohannesRudolph JohannesRudolph released this 28 Aug 16:16

What's Changed

New Features

Breaking Changes

Docs V2

The "collie foundation docs" command no longer generates documentation using logic built into collie-cli.
The new "v2" approach for generating docs using collie leverages
terragrunt with a foundation-level terraform module that builds
the documentation. This approach is more versatile and more performant

  • uses terraform_remote_state to quickly download documentation_md output
    from all platform modules, which is much faster than any other approach
    we tried before (see #271)
  • the terraform module can freely implement templating, ie symlinking
    the documentation site generator templates to enable docs hot reloading
  • users have better control to work natively with the documentation generator
    of their choice, because logic is moved out of collie-cli

The terraform module that we will make available on collie-hub for now unfortunately
no longer has support for generating kit module documentation. However
we have found that there's little value in generating kit module documentation
outside of the collie-hub use case, as most cloud foundation teams want
to generate documentation for their application teams and are content with
re-viewing terraform module documentation directly off the README.md files
in git.

Removed collie kit compile

The "collie kit compile" command is no longer part of collie-cli.

We figured out this use case is better served by tools like pre-commit-terraform
https://github.com/antonbabenko/pre-commit-terraform?tab=readme-ov-file#terraform_validate
which includes more robust handling of terraform's quirks. Given that
there are better solutions out there, we think it's best to remove this
feature from collie and focus our resources on unique features.

See #296 for more details

Fixes and other Changes

New Contributors

Full Changelog: v0.26.0...v0.27.0