Version updated for https://github.com/GhrammR/the-janitor to version v5.8.1.

• This action is used across all versions by ? repositories.

Action Type

This is a Docker action.

Go to the GitHub Marketplace to find the latest changes.

Action Summary

The Janitor is a GitHub Action designed to automate the detection and removal of dead code at the symbol level (functions, classes, and files) across multiple programming languages, including Python, Rust, JavaScript/TypeScript, and C++. It identifies unused code through static analysis and heuristic-based detection, simulates deletions to ensure test coverage, and safely removes redundant code without corruption, streamlining code cleanup and maintenance. The action also supports deduplication of duplicate logic and offers optional features like signed integrity attestations for CI pipelines.

Release notes

The Janitor: Automated Dead Symbol Detection & Code Cleanup

Current Version: v5.8.1

Stop paying for code you don’t use.

The Janitor creates a Shadow Tree to verify deletion safety, then surgically removes dead code at the symbol level — functions, classes, and entire orphan files — across Python, Rust, JavaScript/TypeScript, and C++ codebases.

How It Works

1. Scan — Static reference graph + 6-stage heuristic pipeline identifies every dead symbol.
2. Simulate — Shadow Tree overlays links to the dead files. Your test suite runs against the simulated deletion.
3. Remove — Tests pass? Dead code is removed bottom-to-top (byte-precise, UTF-8 hardened). Tests fail? Full rollback, zero corruption.

Quick Start

# Free: detect dead code
janitor scan ./src

# Free: find duplicate functions (structural clone detection)
janitor dedup ./src

# Free: simulate + remove (no token required)
janitor clean ./src --force-purge

Language Support

False-Positive Protection

17-variant protection system. Heuristics cover:

• FastAPI route decorators, dependency injection, lifespan teardown
• Pydantic validators, forward references, alias generators
• SQLAlchemy metaprogramming, hybrid properties, polymorphic mappers
• pytest fixtures, conftest.py, test fingerprinting
• Qt auto-connection slots, ORM lifecycle methods
• Plugin directories (Scrapy, Celery, Django management commands)
• Grep shield: Aho-Corasick scan of all non-Python files

Pricing

Cleanup is Free. Integrity Attestations are Paid.

Get started at thejanitor.app

CI Integration

- uses: GhrammR/the-janitor@v5
  with:
    path: ./src
    args: scan --verbose

For automated cleanup in CI (free):

- uses: GhrammR/the-janitor@v5
  with:
    args: clean --force-purge
    path: ./src

For signed attestation in CI (Lead Specialist tier):

- uses: GhrammR/the-janitor@v5
  with:
    args: clean --force-purge --token ${{ secrets.JANITOR_TOKEN }}
    path: ./src

Commands

License

Business Source License 1.1 (BSL 1.1) — Source Available. Converts to MIT on 2030-02-15.

Scan, cleanup, badge, and dashboard are permanently free. Integrity attestation (signed audit logs, PQC compliance reports) requires a Lead Specialist token.

• GhrammR
• GitHub Actions