This bot is an automated tool designed to help maintain repositories by identifying and notifying about stagnant code files that might require review. It assists in keeping your projects up-to-date and promotes regular code reviews to ensure code quality.
CodeReviewBot analyzes the commit history of files within your repository to identify files that have not been modified for a certain period of time. When it detects such stagnant files, it creates an issue within the repository, suggesting that a code review may be needed for those files.
- Automated identification of stagnant code files.
- Creation of issues for files that haven't been modified recently.
- Customizable time threshold for considering files as stagnant.
- Helps maintain code quality by encouraging regular reviews.
- Reduces the risk of having outdated or unmaintained code.
To configure the app, create a .revive-bot.yml file in the root of your repository with the following options:
# Schedule when the bot checks for stagnant files (cron format)
# Visit https://crontab.guru
cron: '11 2 6 * *' # Runs on the 6th day of each month at 02:11 AM
# Define file patterns to analyze using glob syntax
# glob: '**/*.py' # Analyze all Python files
# glob: 'src/**/*.js' # Analyze JavaScript files in the src directory and its subdirectories
glob: '**/*.py' # Example: analyze all Python files
# Limit the maximum number of files listed in an issue
limit: 5