GitHub Repo Cleaner

This utility provides functionalities to clean up various components of a GitHub repository including tags, action runs, releases, and all commits.

Prerequisites

• bash
• git
• gh (GitHub CLI)
• jq (for processing JSON)

Installation

npm i -g github-repo-cleaner

Usage

Basic Command:

clean-repo <user/repo> <token> [options]

Required Arguments:

• <user/repo>: The GitHub repository in the format username/repository_name.
• <token>: Your GitHub personal access token.

Options:

• --deleteTags: Delete all tags.
• --deleteActionRuns: Delete all GitHub Action runs.
• --ignoreActionRunIds=id1,id2,...: Specify action run IDs to ignore.
• --deleteReleases: Delete all releases.
• --deleteDeployments: Delete all deployments.
• --deleteAllCommits: Delete all commits.

Example:

To delete all tags and action runs for a specific repository:

clean-repo username/myrepo myaccesstoken --deleteTags --deleteActionRuns

To specify certain action run IDs to ignore:

clean-repo username/myrepo myaccesstoken --ignoreActionRunIds=1234,5678

Warning

⚠️ Use this script with caution. The operations are irreversible. Make sure you've backed up any vital data.

License

• Specify the licensing here or state it's open for general use.