Recently we built a library that would lint & fix
yamls, that we also did embed as a Github Action so we could use this tool as part of our CI pipeline :
What we did not know at that time is that...
that was just the beginning of a journey.
Progressively we started to focus on
cli user experience, features, packaging and delivery.
So the context slowly started to shift from a background hidden tool to a full tool, with more features and more integrations.
We started to automate package delivery on
pypi, make install process much easier, create demo scenarios, create one liners, plug into
jq , plug it into gomplate template engine, ...integration scenarios and many other exciting things, very efficiently around our Dev & OPS pipeline, all that very naturally.
While the collaboration through GH issues was fully remote, we even did an internal (30' minutes long) meetup to share about vision and issues.
At the end of the first week I was mesmerized :
we wanted a
clitool to fix
yamlsbut finally we built a community !
Find below first live demo video (in French) with a lot of more details about what we did :
Below some dedicated
asciinema demos :
Feel free to contribute yours on the GH project 👇
Many thanks to the core team I really enjoy working with on a daily basis on many other DevOPS challenges, helping pushing disruptive new ideas :
For more about the project just :
Here'a screenshot of yamlfixer launched on yaml-test-suite :
The easiest way to install
yamlfixer is from
pypi, as described
🐧 Linux install
python3 -m pip install yamlfixer-opt-nc
🪟 Windows install
python -m pip install yamlfixer-opt-nc
For an optimal experience we recommand using
To install :
pipx install yamlfixer-opt-nc pipx list
To upgrade :
pipx upgrade yamlfixer-opt-nc
To uninstall :
pipx uninstall yamlfixer-opt-nc
This software automatically fixes some errors and warnings reported by
usage: yamlfixer [-h] [-v] [-b] [-B BACKUPSUFFIX] [-d] [-D DIFF_FILE] [-e EXTENSIONS] [-f] [-F] [-l] [-N] [-n] [-r LEVEL] [-j | -p | -s] [-t TABSIZE] [-c CONFIG_FILE | -C CONFIG_DATA] [FILE_or_DIR [FILE_or_DIR ...]] Fix formatting problems in YAML documents. If no file is specified, then reads input…