Release Clean

Deterministic Git cleanup and release checkout. Control, predictability, and conscious cleanup for local release preparation.

What is Release Clean?

Release Clean is a deterministic Git utility designed to clean, reset, and position your local repository into a trusted release state before working on a specific release branch.

It removes ignored files, resets tracked changes, synchronizes main, and checks out the target release/<VERSION> branch in a predictable and auditable sequence.

Release Clean does not try to replace your release process. It prepares the local environment so the repository starts from a controlled state before release validation or operational work.

Key Features

Cleanup based on .gitignore
Preserves node_modules/
Resets tracked files using git checkout -- .
Validates Git repository context before execution
Validates version format before building the branch
Explicit confirmation before destructive actions (y/N)
Stops immediately on the first error
Final summary with audit of executed actions

Installation

pip3 install release-clean

The tool is executed directly via the terminal through an interactive prompt.

Using Release Clean

release-clean

The tool will prompt you to provide:

Release version
Execution confirmation with y/N

Final Summary

At the end of execution, Release Clean presents a consolidated summary including repository path, version, final branch, total successful actions, failed actions, and the full ordered command list.

Final Summary
Repository   : /path/to/repo
Version      : 2.100.1
Final branch : release/2.100.1
Success      : 8
Failures     : 0

This summary improves auditability, traceability, and operational confidence.

Accepted Version Examples

1.0.0
2.100.1
2.100.1-hotfix
3.4.5-rc1