Skip to content

Releases: meshcloud/collie-cli

v0.27.0

28 Aug 16:16
Compare
Choose a tag to compare

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

v0.26.0

25 Mar 20:02
Compare
Choose a tag to compare

What's Changed

  • chore: upgrade to deno 1.41, cliffy v1.0 rc3 and std lib to 0.216. This significantly reduces the size of collie binaries. by @JohannesRudolph in #285
  • feat: skip selecting foundations if repo only has a single one by @JohannesRudolph in #284
  • feat: collie test command. This adds a workflow for running terraform test in dedicated terragrunt configurations by @JohannesRudolph in #286
  • feat: force collie to exit when receiving second interrupt from user by @JohannesRudolph in #287
  • feature/drop deno unstable by @JohannesRudolph in #280

Full Changelog: v0.25.0...v0.26.0

v0.25.0

13 Mar 15:15
c55f39e
Compare
Choose a tag to compare

Important Changes

collie-cli now uses the latest tagged version of the collie-hub repo if not set differently via collie/config.json

What's Changed

Full Changelog: v0.24.0...v0.25.0

v0.24.0

05 Feb 09:23
Compare
Choose a tag to compare

Important Changes

Unfortunately we decided to remove the fast documentation output collection introduced in v0.23.0 as it did prove unreliable in practice. No changes are necessary to your collie repositories. Subscribe to #273 to follow our search for a better alternative.

What's Changed

Full Changelog: v0.23.0...v0.24.0

v0.23.0

24 Nov 15:24
Compare
Choose a tag to compare

Upgrade Instructions

This is not a strictly "breaking", but highly recommended change. When running collie foundation docs collie needs to fetch the documentation_md output from all terraform modules in your platforms. This can be quite slow, so collie tried to parallelize this process, which unfortunately leads to bugs described in #265

Collie will now default to a serial execution (safe by default) and optionally activates a faster mode supported by terragrunt run-all if your platform.hcl has the following required terragrunt hook

terraform {
  before_hook "collie_info" {
    commands     = ["apply", "plan", "output"]
    execute      = ["echo", "--- BEGIN COLLIE PLATFORM MODULE OUTPUT: ${path_relative_to_include()} ---"]
  }
}

This hook helps collie parse the output correctly and as a nice side-effect, we also find it enhances the readability of logs.

What's Changed

Full Changelog: v0.22.2...v0.23.0

v0.22.2

02 Nov 08:23
Compare
Choose a tag to compare

What's Changed

Full Changelog: v0.22.1...v0.22.2

v0.22.1

16 Oct 19:22
Compare
Choose a tag to compare

What's Changed

Fixes

CI pipeline improvements

New Contributors

Full Changelog: v0.22.0...v0.22.1

v0.22.0

25 Sep 18:30
Compare
Choose a tag to compare

What's Changed

Full Changelog: v0.21.1...v0.22.0

v0.21.1

24 Sep 12:44
Compare
Choose a tag to compare

What's Changed

Full Changelog: v0.21.0...v0.21.1

v0.21.0

24 Sep 12:11
Compare
Choose a tag to compare

What's Changed

Full Changelog: v0.20.0...v0.21.0