goncaloMagalhaes / git-daily-autocommiter

Daily autocommit your notes on what you've done, read, learned, etc

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Git Daily Autocommiter

How about you log your daily activities on github? Look no further!

Git Daily Autocommiter is a script written in Rust that reads a file and commits and pushes its contents to a GitHub repository. You can use it to automatically log your daily activities, such as the papers or articles you've read, the repositories you've contributed to, the languages you've started learning, etc.

I'm learning Rust, so really the point here was also for me to learn while doing.

Getting started

To get started with Git Daily Autocommiter, you'll need to set up a few environment variables. Here's what you'll need: REPO_PATH FILE_BASE_NAME SSH_PRIVATE_KEY_PATH COMMIT_AUTHOR COMMIT_EMAIL

  • SSH_PRIVATE_KEY_PATH: File path to the GitHub ssh key.
  • REPO_PATH: The path to the GitHub repository where you want to push the code.
  • FILE_BASE_NAME: The base name of the file you want to read from. The script will concatenate this with the current date to create the actual file name to read from.
  • COMMIT_AUTHOR: Your GitHub username.
  • COMMIT_EMAIL: Your GitHub email.

Once you have these environment variables set up, you can run the script by simply executing cargo run in your terminal.

Automating with crontab

To make sure you never forget to commit your logged daily activities, you can add Git Daily Autocommiter to your crontab. Something like this:

0 0 * * * <path-to-your-script>/git-daily-autocommiter

This line tells crontab to run the script every day at midnight. You can change the schedule to fit your needs by modifying the first five fields of the line.

About

Daily autocommit your notes on what you've done, read, learned, etc


Languages

Language:Rust 100.0%