v1.1.1 - 2024-10-14

Release Notes

Fixed

• kerblam data clean now no longer deletes hidden files (starting with a dot),
  like .gitignore files in data directories.

Install kerblam 1.1.1

Install prebuilt binaries via shell script

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/MrHedmad/kerblam/releases/download/v1.1.1/kerblam-installer.sh | sh

Download kerblam 1.1.1

File	Platform	Checksum
kerblam-aarch64-apple-darwin.tar.xz	Apple Silicon macOS	checksum
kerblam-x86_64-apple-darwin.tar.xz	Intel macOS	checksum
kerblam-x86_64-unknown-linux-gnu.tar.xz	x64 Linux	checksum
kerblam-x86_64-unknown-linux-musl.tar.xz	x64 MUSL Linux	checksum

v1.1.0 - 2024-09-26

Release Notes

New

• kerblam new now creates additional gitignore files in the data folder to
  include the data folders themselves but ignore all files inside them.
  Data files or folders that need to be committed to version control need to
  be explicitly listed in the .gitignore files in the appropriate place.

Install kerblam 1.1.0

Install prebuilt binaries via shell script

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/MrHedmad/kerblam/releases/download/v1.1.0/kerblam-installer.sh | sh

Download kerblam 1.1.0

File	Platform	Checksum
kerblam-aarch64-apple-darwin.tar.xz	Apple Silicon macOS	checksum
kerblam-x86_64-apple-darwin.tar.xz	Intel macOS	checksum
kerblam-x86_64-unknown-linux-gnu.tar.xz	x64 Linux	checksum
kerblam-x86_64-unknown-linux-musl.tar.xz	x64 MUSL Linux	checksum

v1.0.0

Kerblam! Version 1.0.0

This is the first official release of Kerblam! Hurray!

You can read all about Kerblam! here on Github with the README, or immediately start with the manual on kerblam.dev.

Changelog

• ! BREAKING CHANGE: The default behaviour of kerblam data clean was changed. Now, remote data are not deleted by default, as if you ran kerblam data clean --keep-remote. To also delete remote data, pass the flag --include-remote, e.g. kerblam data clean --include-remote. During day-to-day usage, deletion of remote data is often not wanted, so it's much better to treat the deletion of remote data as an exception rather than a rule.
  • As a result, the --keep-remote flag has been deleted.

New

• The error message you get when running kerblam run with no parameters now includes a list of available profiles, or tells you that you have specified no profiles.
• All the help messages (e.g. kerblam --help) were revamped to be more complete and explicit on what each command does.

Install kerblam 1.0.0

Install prebuilt binaries via shell script

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/MrHedmad/kerblam/releases/download/v1.0.0/kerblam-installer.sh | sh

Download kerblam 1.0.0

File	Platform	Checksum
kerblam-aarch64-apple-darwin.tar.xz	Apple Silicon macOS	checksum
kerblam-x86_64-apple-darwin.tar.xz	Intel macOS	checksum
kerblam-x86_64-unknown-linux-gnu.tar.xz	x64 Linux	checksum
kerblam-x86_64-unknown-linux-musl.tar.xz	x64 MUSL Linux	checksum

Version 1.0.0-rc.3

Release Notes

This release adds a few tweaks that should be made now before 1.0.0 and we must be retrocompatible.

Changed

• BREAKING CHANGE: The default path for workflows was changed from src/pipes to src/workflows.
  • The "pipeline" terminology is apparently quite old, and therefore "workflow" sounds more natural to the modern ear.
• The book and README were quite heavily updated to reflect the nature of Kerblam!. A quickstart project was added to get people started with an hand-on approach.

Fixed

• The test profile could not be used if the data.profiles section of the TOML was not there (even if empty). This was fixed by @MrHedmad in #104
• If you deleted some profile files between profiled runs, the cache would tell Kerblam! to touch the files, but it would fail, since they are not found. Now, Kerblam! just silently ignores these files - if they are no there, there is no need to update their timestamps, is there? Fixed by @MrHedmad in #102

Install kerblam 1.0.0-rc.3

Install prebuilt binaries via shell script

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/MrHedmad/kerblam/releases/download/v1.0.0-rc.3/kerblam-installer.sh | sh

Download kerblam 1.0.0-rc.3

File	Platform	Checksum
kerblam-aarch64-apple-darwin.tar.xz	Apple Silicon macOS	checksum
kerblam-x86_64-apple-darwin.tar.xz	Intel macOS	checksum
kerblam-x86_64-unknown-linux-gnu.tar.xz	x64 Linux	checksum
kerblam-x86_64-unknown-linux-musl.tar.xz	x64 MUSL Linux	checksum

v1.0.0-rc.2

This release candidate adds a few fixes and features, and it is probably the closest to a real release of Kerblam! that we will get.

What's Changed

New features

• kerblam run now accepts command-line arguments to be passed directly to the workers that it spawns (i.e. make or bash) by using two dash separators: e.g. kerblam run ... -- arg1 arg2 (@MrHedmad in #88)
• Kerblam! now caches the name of the last profile used, so that it can skip updating timestamps if the same profile is used back-to-back. This allows make to properly skip rebuilding files that should not be rebuilt when using profiles (@MrHedmad in #89).

Bug Fixes

• make properly changes working directory following kerblam.toml in docker by @MrHedmad in #92
• Perfect some aspect of directory-based profiles by @MrHedmad in #94

Documentation

• The documentation was updated in many aspects (@MrHedmad in #85, @MrHedmad in #86, #93)
• The book on kerblam.dev now uses callouts thanks to mdbook-callouts (@MrHedmad in #95).
• Added workflows community metadata and icons by @MrHedmad in #98

Full Changelog: v1.0.0-rc.1...v1.0.0-rc.2

---

There are no quick links to the installers due to an issue in the release process. Sorry! You can still download them with the buttons below.

v1.0.0-rc.1

This release adds the replay command and changes quite dramatically how the containers are packaged.
The main differences are:

• ❗ The kerblam package command works differently:
  • The data is no longer included in the package;
  • A new tarball is created with the (precious-only) input data, the name of the container (in a name file) and the kerblam.toml.
  • The entrypoint was changed from kerblam data fetch && make ... or kerblam data fetch && bash... to simply kerblam data fetch && kerblam run <packaged pipeline>.
• The kerblam replay command was added. It takes a package tarball, reads the kerblam.toml file to find out where the input files were, and unpacks them. It then takes the name of the docker container and runs it with the proper bindings.
  • You can do all of this manually, but it's much more convenient to have Kerblam! do it for you.

The documentation was also updated quite thoroughly. The PR for this release was #69 by @MrHedmad.

Install kerblam 1.0.0-rc.1

Install prebuilt binaries via shell script

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/MrHedmad/kerblam/releases/download/v1.0.0-rc.1/kerblam-installer.sh | sh

Download kerblam 1.0.0-rc.1

File	Platform	Checksum
kerblam-aarch64-apple-darwin.tar.xz	Apple Silicon macOS	checksum
kerblam-x86_64-apple-darwin.tar.xz	Intel macOS	checksum
kerblam-x86_64-unknown-linux-gnu.tar.xz	x64 Linux	checksum
kerblam-x86_64-unknown-linux-musl.tar.xz	x64 MUSL Linux	checksum

v1.0.0-rc.0

Install kerblam 1.0.0-rc.0

Install prebuilt binaries via shell script

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/MrHedmad/kerblam/releases/download/v1.0.0-rc.0/kerblam-installer.sh | sh

Download kerblam 1.0.0-rc.0

File	Platform	Checksum
kerblam-aarch64-apple-darwin.tar.xz	Apple Silicon macOS	checksum
kerblam-x86_64-apple-darwin.tar.xz	Intel macOS	checksum
kerblam-x86_64-unknown-linux-gnu.tar.xz	x64 Linux	checksum
kerblam-x86_64-unknown-linux-musl.tar.xz	x64 MUSL Linux	checksum

v0.5.1 - Cogs and Wrenches

This version includes a hotfix for containerized runs.

What's Changed

• fix: fix bad parsing of root dir path by @MrHedmad in #63
  • The default path ("/") was not applied correctly to internal (host) paths since Rust's PathBuf treats it as an empty path. This was fixed.
  • Reverted a breaking change whereas the src/dockerfiles default path was changed to src/containers, but this was not supposed to be released yet.

Full Changelog: v0.5.0...v0.5.1

Install kerblam 0.5.1

Install prebuilt binaries via shell script

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/MrHedmad/kerblam/releases/download/v0.5.1/kerblam-installer.sh | sh

Download kerblam 0.5.1

File	Platform	Checksum
kerblam-aarch64-apple-darwin.tar.xz	Apple Silicon macOS	checksum
kerblam-x86_64-apple-darwin.tar.xz	Intel macOS	checksum
kerblam-x86_64-unknown-linux-gnu.tar.xz	x64 Linux	checksum
kerblam-x86_64-unknown-linux-musl.tar.xz	x64 MUSL Linux	checksum

v0.5.0 - Gears and Wrenches

This release mainly changes stuff at the backend of Kerblam! making it more streamlined for future development. However, there are some small features that slipped through the cracks in the other versions.

What's Changed

Features

• Refactor code and add tiny features by @MrHedmad in #60
  • The "tiny features" are markdown (esque) rendering of pipe descriptions with kerblam run pipe --desc and allows Kerblam! to use a default dockerfile (aptly named default.dockerfile) for all pipes if no specific dockerfile is found. The container icon (a 🐳 ) is swapped out for a more modest 🐟 if a pipeline uses the default dockerfile.

Fixes

• fix: do not overwrite any files in profiles (#9) by @MrHedmad in #61
  • Potentially useless, but it's there now. If you have a file.txt.original (for some reason) and kerblam! would overwrite it, it now stops before doing something potentially destructive.

Backend changes

• Add Tests to Kerblam! by @MrHedmad in #62
  • Kerblam! has shiny new tests! They don't cover much for now, but they provide the grounds to write more.
  • Taken the time to refactor functions to be more testable.

Install kerblam 0.5.0

Install prebuilt binaries via shell script

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/MrHedmad/kerblam/releases/download/v0.5.0/kerblam-installer.sh | sh

Download kerblam 0.5.0

File	Platform	Checksum
kerblam-aarch64-apple-darwin.tar.xz	Apple Silicon macOS	checksum
kerblam-x86_64-apple-darwin.tar.xz	Intel macOS	checksum
kerblam-x86_64-unknown-linux-gnu.tar.xz	x64 Linux	checksum
kerblam-x86_64-unknown-linux-musl.tar.xz	x64 MUSL Linux	checksum

Full Changelog: v0.4.0...v0.5.0

v0.4.0 - Much too convenient

In this much too convenient release, I've added a few QOL changes that were in the issues for a long time. You can stop writing your own entrypoints in dockerfiles (convenient), you can change the dockerized working directory in the kerblam.toml file (super convenient!), tell your pipelines that they are being profiled (very... convenient for them), cleanup your empty directories (suspiciously convenient) and use Podman instead of Docker (for a more convenient local execution).

What's Changed

New features

• Add a way to show long descriptions of pipes by @MrHedmad in #50
  • kerblam run my_pipe --desc will print out the full description of a pipe (if there is one).
• Infer test profile automatically given file names by @MrHedmad in #52
  • If [profiles.test] is not defined, Kerblam! will make one up by swapping all test_xxx files with xxx files. Convenient!
• Set the KERBLAM_PROFILE env variable when in a profile by @MrHedmad in #53
  • Pipes can now be aware they are in a profile, an act accordingly.
• Warn the user if they fetch to a file not in the input data dir by @MrHedmad in #54
  • If you mistakenly add a / to the start of your retrieved file, kerblam! will warn you before doing something you might regret.
• Cleaning data files now removes empty directories left behind by @MrHedmad in #55
  • Your /data folder will be squeaky clean. Suppress this with the --keep-dirs flag.
• Automatically find kerblam.toml in parent dirs by @MrHedmad in #56
  • You can Kerblam! almost anywhere now!
• Add podman support by @MrHedmad in #57
  • If you like FOSS options now you can use Podman instead of Docker as your container runner of choice.
• Overhaul containerized execution by @MrHedmad in #58
  • Kerblam! will set the correct ENTRYPOINT so you don't have to set it yourself anymore. Super convenient!
  • You can now tell kerblam! if you are packaging your pipeline in anywhere other than the root of the container, so you can keep everything separated nicely.
• Update documentation with new features by @MrHedmad in #59
  • There are several new features, and the docs are updated to reflect this. Read them again if you want the full picture!

Backend changes

• Drop openssl requirement by @MrHedmad in #43
  • Sorry if you had trouble installing kerblam! due to this. Gets rid of a series of missing libssl.1.1 errors on various OSes.

Fixes

• Ask again if user types nothing as an answer (#49) by @MrHedmad in #51
  • Kerblam! used to crash if you just pressed enter at one of its prompts. No longer! It will demand an answer from you - forever!

Full Changelog: v0.3.0...v0.4.0

Install kerblam 0.4.0

Install prebuilt binaries via shell script

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/MrHedmad/kerblam/releases/download/v0.4.0/kerblam-installer.sh | sh

Download kerblam 0.4.0

File	Platform	Checksum
kerblam-aarch64-apple-darwin.tar.xz	Apple Silicon macOS	checksum
kerblam-x86_64-apple-darwin.tar.xz	Intel macOS	checksum
kerblam-x86_64-unknown-linux-gnu.tar.xz	x64 Linux	checksum
kerblam-x86_64-unknown-linux-musl.tar.xz	x64 MUSL Linux	checksum