2.3.0 • Published 3 years ago

batch-commit v2.3.0

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

batch-commit

Automate commits to a repository with batch commits and tagging.

Test Codacy Badge Project Status: Active – The project has reached a stable, usable state and is being actively developed. oclif

Installation

npm i -g batch-commit

Development Setup

  1. Clone repository:
  2. Install dependencies: npm install
  3. Run npm link to make batch-commit available in other directories

Usage

$ npm install -g batch-commit
$ batch-commit COMMAND
running command...
$ batch-commit (-v|--version|version)
batch-commit/2.3.0 darwin-x64 node-v16.4.2
$ batch-commit --help [COMMAND]
USAGE
  $ batch-commit COMMAND
...

Commands

batch-commit help [COMMAND]

display help for batch-commit

USAGE
  $ batch-commit help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

batch-commit run

Batch create empty commits and tags to trigger CI activities

USAGE
  $ batch-commit run

OPTIONS
  -c, --file=file                      Path to a txt file with a new-line seperated list of values to be used as the
                                       --value

  -f, --key=key                        (required) The flag name to add to the commits

  -m, --commit-message=commit-message  (required) The commit message prefix (used for all commits when used with --file)

  -p, --push                           Push to the remote after each commit

  -v, --value=value                    The value passed to the key

  --tag                                Create tags along with commits

EXAMPLES
  $ batch-commit run --key="foo" --value="var" --commit-message="Example Commit"
  - Adds a single empty commit on the current branch with a commit message: "Example commit --foo=bar"
  
  $ batch-commit run --key="foo" --file="./text.txt" --commit-message="Example Commit"
  - Adds multiple commits using values using each line of "./text.txt" file: "Example commit --foo={line from file}"
  
  $ batch-commit run --key="foo" --value="bar" --commit-message="Example Commit" --tag
  - The --tag option will create a tag for the commit also

See code: src/commands/run.js

Built with