Skip to content

Uses GitHub Actions to automatically generate commits daily or on specific dates chosen by the user. ๐Ÿ€

Notifications You must be signed in to change notification settings

fbjs12034/auto-commit-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

2 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Auto Commit Generator

Introduction

Auto Commit Generator Uses GitHub Actions to automatically generate commits daily or on specific dates chosen by the user.

Before / After

Before:

After:

Features

Daily Commit

  • Description: Automatically generates a specified number of commits every day.
  • Configuration File: daily.json
    • commitMessage: Commit message
    • gitUserName: Github username
    • gitUserEmail: Github user email
    • minCommitCount: Minimum number of commits per day
    • maxCommitCount: Maximum number of commits per day

Backdate Commit

  • Description: Manually generates a specified number of commits on chosen dates.
  • Configuration File: backdate.json
    • startDate: Start date (format: YYYY-MM-DD)
    • endDate: End date (format: YYYY-MM-DD)
    • minCommitCount: Minimum number of commits per day
    • maxCommitCount: Maximum number of commits per day

Installation and Usage

  1. Fork the Project

    • Fork this repository.
    • You can set up and run the project directly on GitHub without cloning the forked repository.
  2. Create a GitHub Personal Access Token

  1. Set Up GitHub Secrets

    1. Go to the GitHub page of the forked repository.
    2. Navigate to Settings > Secrets and variables > Actions.
    3. Click New repository secret and name it AUTO_COMMIT_TOKEN.
    4. Enter the generated Personal Access Token in the Value field and click Add secret.
  2. Modify Configuration Files

    • Adjust the daily.json and backdate.json files 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
      }
  3. Run GitHub Actions

    • Go to the Actions tab in the GitHub repository.
    • Manually run the desired workflow (Daily Commit or Backdate Commit) or set it to run automatically.
    • Daily Commit runs automatically every day at 00:30 UTC.

Contributing

If you would like to contribute to this project, please submit a pull request or open an issue.

License

This project is licensed under the MIT License.

About

Uses GitHub Actions to automatically generate commits daily or on specific dates chosen by the user. ๐Ÿ€

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published