Repository navigation
Release Notes for Treefmt GitHub Action v1.0.0
Overview
This release marks the initial launch of the Treefmt GitHub Action, which helps you format your codebase using the treefmt tool. This action automates the process of applying formatters configured in your treefmt.toml file, ensuring your code adheres to your project's formatting standards.
Features
- Version Selection: Specify the version of
treefmtto install with theversioninput. Default islatest. - Configuration File: Use the
config_fileinput to specify the path to yourtreefmt.tomlconfiguration file. Default istreefmt.toml. - Working Directory: Set the working directory for
treefmtwith theworking_directoryinput. Default is the current directory. - Cache Control: Control caching behavior with the
no_cacheandclear_cacheinputs. - Fail on Change: Use the
fail_on_changeinput to make the action exit with an error if any changes are made to your files. - Formatter Selection: Specify which formatters to apply using the
formattersinput. - Tree Root and Root File: Configure the root directory for file traversal with the
tree_rootandtree_root_fileinputs. - Traversal Method: Select the method for file traversal (
auto,git, orfilesystem) with thewalkinput. Default isauto. - Verbosity: Increase logging verbosity with the
verboseinput. - Handle Unmatched Paths: Log paths that did not match any formatters at a specified log level with the
on_unmatchedinput.