Initial CLI implementation - Githubissues

OpenBagTwo / gsb

A tool for managing incremental backups of your save states using Git!

https://openbagtwo.github.io/gsb/

GNU General Public License v3.0

0 stars 0 forks source link

Initial CLI implementation #22

Closed OpenBagTwo closed 1 year ago

OpenBagTwo commented 1 year ago

Summary

Implements the first gsb CLI commands

List of Changes

Uses click to implement and expose:
- gsb backup [--tag "message"] (implements #3)
- gsb init [[--track] INCLUDE_PATTERN]... [--ignore IGNORE_PATTERN] (implements #1)
- gsb --version to print the version
- gsb --help and gsb <verb> --help to print help messages
Adds CLI docs to the gh pages documentation

Tech Debt and Other Concerns

Validation Performed

[x] Unit tests
[x] Ran gsb --help and gsb <verb> --help for all commands, reading through and tweaking the output until it looked good
[x] I messed up one of the tests where it ended up actually running gsb init in the project root and--lo and behold--I ended up with the expected commits, tags, manifest and modifications to the .gitignore until I squashed out that commit

PR Type

[ ] This PR introduces a breaking change (will require a bump in the minor version)
[ ] The changes in this PR are high urgency and necessitate a hotfix or patch release (will require rebasing off of release)
[ ] This is a release (staging) PR (maintainer use only)

Checklist:

[x] I have read the contributor's guide
[x] I have run mkdocs serve locally and ensured that all API docs and changes I have made to the static pages are rendering correctly, with all links working
[x] All tech debt concerns have been resolved, documented as issues, or otherwise accepted
[x] I agree to license my contribution to this project under the GNU Public License v3