Auto Commit Generator Uses GitHub Actions to automatically generate commits daily or on specific dates chosen by the user.
Before:
After:
- Description: Automatically generates a specified number of commits every day.
- Configuration File:
daily.jsoncommitMessage: Commit messagegitUserName: Github usernamegitUserEmail: Github user emailminCommitCount: Minimum number of commits per daymaxCommitCount: Maximum number of commits per day
- Description: Manually generates a specified number of commits on chosen dates.
- Configuration File:
backdate.jsonstartDate: Start date (format: YYYY-MM-DD)endDate: End date (format: YYYY-MM-DD)minCommitCount: Minimum number of commits per daymaxCommitCount: Maximum number of commits per day
-
Fork the Project
- Fork this repository.
- You can set up and run the project directly on GitHub without cloning the forked repository.
-
Create a GitHub Personal Access Token
- Generate a new token in GitHub Settings.
- Required permission:
repo
-
Set Up GitHub Secrets
- Go to the GitHub page of the forked repository.
- Navigate to
Settings > Secrets and variables > Actions. - Click
New repository secretand name itAUTO_COMMIT_TOKEN. - Enter the generated Personal Access Token in the Value field and click
Add secret.
-
Modify Configuration Files
- Adjust the
daily.jsonandbackdate.jsonfiles in the project root as needed. - Example
daily.json:{ "commitMessage": "Auto Commit Generator", "gitUserName": "github-username", "gitUserEmail": "github@email.com", "minCommitCount": 1, "maxCommitCount": 5 } - Example
backdate.json:{ "startDate": "2024-05-10", "endDate": "2024-05-11", "minCommitCount": 1, "maxCommitCount": 5 }
- Adjust the
-
Run GitHub Actions
- Go to the
Actionstab in the GitHub repository. - Manually run the desired workflow (
Daily CommitorBackdate Commit) or set it to run automatically. - Daily Commit runs automatically every day at 00:30 UTC.
- Go to the
If you would like to contribute to this project, please submit a pull request or open an issue.
This project is licensed under the MIT License.