@pejulian/gitops v0.1.0-beta.0

@pejulian/gitops

Swiss army knife for running DevOps like tasks on NPM based repositories in your Git organization.

• gitops
  • Is this module for me?
  • Installation
  • Setup
  • Globals
    • Github Personal Access Token (PAT)
    • Default Git Host
  • Commands
    • add-package-json-script
    • download-respository
    • find-and-replace
    • install-package
    • reinstall-package
    • remove-package
    • rename-file
    • remove-package-json-script
    • update-package-version
    • uninstall-package
  • Development

Is this module for me?

If you have many projects based on NodeJS (e.g. the project root has a package.json), then this project may be helpful for you.

Installation

Run gitops via npx (recommended):

npx gitops

or with a specified version or tag:

npx gitops@0.1.0
# or
npx gitops@beta

Install gitops globally on your machine:

npm install -g gitops

Setup

gitops interacts with your Git organizations and repositories using Git's REST API In order to use the API, a Personal Access Token is required for authentication purposes. This token will be included in every request to Git via REST API headers.

For instructions on how to set up a Personal Access Token (PAT) for your Git user, read this.

The module will look for a file called .git-token in the user's HOME directory to obtain a PAT for use.

However, you can customize this behavior to suit your needs.

1. Via the gitTokenFilePath property in a .gitopsrc.json file in your home directory
   1. Read this for instructions on how to set this up.

Globals

This module will read global configurations from a file named .gitopsrc.json in your home directory, if it exists.

The content of this file must be a valid JSON object.

These are the possible configurations that can be specified:

Github Personal Access Token (PAT)

Tell this module where to find the file containing your PAT via a property called gitTokenFilePath in .gitopsrc.json.

For example:

{
    "gitTokenFilePath": "configs/.my-git-pat.txt"
}

The path must exist in your home directory (echo $HOME)

Default Git Host

By default, this module will run against the official Git REST API base URL which is api.github.com. If you would like to use this module against a different Git service (e.g. enterprise Git setup), specify the gitApiBase property in .gitopsrc.json in your home directory.

For example:

{
    "gitApiBase": "https://github.enterprise.cloud/api/v3"
}

Commands

Run npx gitops --help to view the commands supported by this tool.

add-package-json-script

This command allows you to add a script to the "scripts" section in "package.json" for effected repositories in the given organizations.

Run:

npx gitops add-package-json-script --help

for more information.

download-respository

Downloads repositories (as tarball) for the given organizations. Optionally, extract downloaded tarball.

Run:

npx gitops download-repository --help

for more information.

find-and-replace

This command allows you to find and replace matches of the supplied regex for a given list of files in relevant repositories for the given Git organizations.

Run:

npx gitops find-and-replace --help

for more information.

install-package

This command allows you to install a new package in the effected repositories for the given organizations.

Run:

npx gitops install-package --help

for more information.

reinstall-package

Reinstall an existing package in the effected repositories for the given organizations.

Run:

npx gitops reinstall-package --help

for more information.

remove-package

Remove a given script from the "scripts" section in "package.json" for effected repositories in the given organizations.

Run:

npx gitops remove-package --help

for more information.

rename-file

This command allows you to rename a file across multiple git organizations and repositories.

Run:

npx gitops rename-file --help

for more information.

remove-package-json-script

This command allows you to remove a given script from the "scripts" section in "package.json" for effected repositories in the given organizations.

Run:

npx gitops remove-package-json-script --help

for more information.

update-package-version

This command allows you to update the version of an existing npm package in package.json for all affected repositories in the given organizations.

Run:

npx gitops update-package-version --help

for more information.

uninstall-package

This command allows you to uninstall an existing package from repositories in the given Git organizations.

Run:

npx gitops uninstall-package --help

for more information.

Development

If you cloned this repo and need to test the code locally without publishing to npm, use the following:

npm run local -- [COMMAND] [FLAGS]

Example to rename all instances of "/etc/my-conf" to "their-conf" in all repositories in the organization foo where repository names start with the prefix bar:

npm run local -- rename-file \
  -o foo \
  -r "^bar_" \
  --target-file-path /etc/my-conf \
  --new-file-name their-conf

Example to rename the file "./src/v1/utils/crypto.utils.ts" to "encryption.utils.ts" in the "login-user" repository in the organization "authy" on the "heads/main" (main branch) reference while logging all actions in DEBUG mode:

npm run local -- rename-file \
  -o authy \
  -l DEBUG \
  -r "login-user" \
  --target-file-path ./src/v1/utils/crypto.utils.ts \
  --new-file-name encryption.utils.ts \
  -f heads/main

Example to update the devDependency npm package version of "fancy-deploy" to "beta" in the the "login-user" repository in the organization "fancy" while logging all actions in DEBUG mode

npm run local -- update-package-version \
  -o fancy \
  -l DEBUG \
  -r "login-user" \
  --package-name fancy-deploy \
  --package-version beta \
  --package-type d \

Remove -r if you would like to apply the action across all repositories in this organization