https://github.com/kartikchugh/giterator
Automate commits quickly and iteratively
https://github.com/kartikchugh/giterator
command-line-tool commit git shell shell-script
Last synced: 2 months ago
JSON representation
Automate commits quickly and iteratively
- Host: GitHub
- URL: https://github.com/kartikchugh/giterator
- Owner: KartikChugh
- Created: 2020-05-05T16:40:51.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-05-22T22:01:23.000Z (about 6 years ago)
- Last Synced: 2025-04-03T00:42:35.338Z (about 1 year ago)
- Topics: command-line-tool, commit, git, shell, shell-script
- Language: Shell
- Homepage:
- Size: 172 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# giterator: automated commit scheduler
## Schedule commits from the command line
Giterator is a tool designed to clone the content of existing files incrementally, leaving a chain of commits spaced out over time. Just give it files to recreate, a destination folder, and a time horizon, and then let it work in the background!
The program works by dividing source files into discrete "chunks" that are to be written to disk periodically. The chunks are cached, so the source file can be deleted upon execution if desired.
## Usage is simple
Clone this repository to your computer, or download the `giterate` script directly.
Usage is as follows:
```bash
./giterate.sh
This would create a new `notebook.ipynb` file under the `/StatisticsRepo/` directory in a span of five hours, with regular† commits in between. To work on multiple files at once, run the script concurrently in another shell.
## Fine-tune the process
With recent updates, giterator now allows you to specify the number of chunks, or commits, that should be used when working on your files. Include the commit count when calling the script.
```bash
./giterate.sh "C:/Users/User/notebook.ipynb" "C:/Users/User/StatisticsRepo/" 5 8
```
writes eight commits in five hours, or roughly one commit (doing an eighth of the total work) every 40 minutes. Use the time and chunk settings to tailor the workflow to your liking. Read more at the [official documentation page](https://github.com/KartikChugh/giterator/wiki#giteratesh).
### †Variation
Giterator now supports random variance in commit times and chunk sizes to create a more natural commit history. This feature is enabled by default.
## Dependencies
Just `git` and a Bash shell.
## To-Do
### Bugfixes
- ~~Fix newline behavior~~ [(#1](https://github.com/KartikChugh/giterator/issues/1), [#7](https://github.com/KartikChugh/giterator/issues/7))
- ~~Fix working directory~~ [(#2](https://github.com/KartikChugh/giterator/issues/2), [#5](https://github.com/KartikChugh/giterator/issues/5))
- ~~Restore whitespace writing~~ [(#4)](https://github.com/KartikChugh/giterator/issues/4)
- ~~Ensure full file writing~~ [(#6)](https://github.com/KartikChugh/giterator/issues/6)
### Features
- ~~Parameterize number of commits~~
- Automate pushing to upstream
- Select entire source folders
- ~~Lessen commit time regularity~~
- ~~Create destination folder~~