@ssfbank/push-to-repo NPM

Push To Repo

Commit changes back to the repo from a GitLab CI job.

Uses GitLab API and by default fails quietly (if the pushed file is for example unchanged). Easy to use and flexible to configure.

Configuration

Add GL_PRIVATE_TOKEN to your GitLab repo CI/CD variables with a valid GitLab access token as its value.

Usage

npx push-to-repo -h

All options except the filename are optional(or --all-commit if run in all commit mode). Note that by default the script does not set author details to the commit which means that it will use the credentials of the user who created the access token. This means that the commits will show up in that users commit history etc. If you want to avoid this, set author name and email explicitly.

Usage: push-to-repo -f <file> [options]

Options:
  -f, --file-name <filename>  the file to push
  -a, --all-commit            Push all modified or deleted changes or new files.
  -b, --branch <branch>       the branch to push (default: "CI_COMMIT_BRANCH")
  -m, --message <message>     commit message (default: "Update <filename> [skip ci]")
  -u, --base-url <url>        GitLab API base URL (default: "https://gitlab.com/api/v4")
  -n, --author-name           Author name
  -e, --author-email          Author e-mail
  --fail-on-error             fail the job on error
  -d, --debug                 debug (verbose) mode
  -V, --version               output the version number
  -h, --help                  display help for command

All commit to Gitlab

This mode of commit replaces the -f flag and lets you push all easily handled changes(modified or deleted) to existing files. New files are also added. Renames and chmods are not though.

Example use case in CI

The foremost practical use case for this is the common npm package release pattern where you increment the version of package.json, commit it, then publish it to NPM, all done in CI.

Caveats

Remember that this cli only pushes through the gitlab API, so your current working tree remains unchanged. Gitlab jobs will by default swallow these changes and when the next job in the pipeline starts these are gone as it continues on the same commit. One way of handling this is for any later jobs in the pipeline to be triggered by the commit message.

This goes for the regular --file-name flag as well.

Testing locally

This tool is intended to be used inside GitLab CI but you can test or use it locally by setting the following GitLab CI env variables: CI_PROJECT_ID, CI_PROJECT_DIR, and CI_COMMIT_BRANCH.