@griko/gardener v1.0.0

🌲 gardener

The commits are greener on the other side

🤔 Why this exists

I saw this gardener bot a while back and I thought, "why not try making one myself?" So I'm trying to make an open-source and free to use commit gardener. So your commit fields will always be greener than before. ✨

This is a work in progress. Hopefully this project can be run as a CLI app (finished) and also as a Docker container. Or maybe as a service where anyone can login and start their commit gardening job as they wish.

🐴 How this works

How the gardener works is it creates a separate branch named commitfield, then in every job it adds an empty commit and pushes to remote after commiting.

💾 Prerequisites

Make sure you have Git and Node.js installed.

🔧 How to use

For now, gardener-cli works only by cloning and running manually. See future features for more information.

Fork and clone

1. Fork this project and clone it on your machine
2. Run yarn or yarn install
3. Run the binary at bin/gardener-cli

Any other owned git projects

1. Access your cloned project
2. Install the CLI by running yarn global add @griko/gardener
3. Run the CLI using gardener-cli

🖥 Usage

$ gardener-cli

Usage: gardener-cli [options] [command]

  The commits are greener on the other side

  Options:

    -V, --version           output the version number
    -c, --commits [number]  number of commits per job
    -h, --help              output usage information

  Commands:

    cron                    starts the gardener job
    single                  runs a single commit job

👨‍🏫 Examples

# clone and move to project directory
git clone git@github.com:grikomsn/gardener.git
cd gardener

# running as a cron job
bin/gardener-cli cron

# running as a cron job with specified commits per job
bin/gardener-cli --commits 10 cron

# running a single job using global binary
yarn global add @griko/gardener
gardener-cli single

🚧 Future features

• Automatically create a repository on your account only for 'gardening'
• Run as a standalone or self-hosted app with Docker support
• Add tests (because I should)

You can request or suggest features by submitting an issue.

🦄 Contributing

Yes, I really need your help. Do whatever you can do.

📄 License

MIT.