Skip to content

waitingsong/gitlab-var-helper

Repository files navigation

Create and update GitLab CI/CD environment variables from settings file in toml format, based on gitlab-variable-helper

GitHub tag License Conventional Commits lerna

Installation

npm i gitlab-var-helper
# cli
npm i -g gitlab-var-helper-cli

Usage

Generate token

  1. Open page
https://git.your.com/profile/personal_access_tokens
  1. Create Personal Access Tokens with Scopes
  • api
  • read_repository
  • write_repository
  1. Remember the generated token
Upw_foooooooooooo

Create settings file

# settings.toml
title = "gitlab var settints"
host = "https://git.your.com"
token = "Upw_foooooooooooo"

# groups ids
gids = [ 13 ]

# project ids
pids = [ 76, 77 ]

# gVars.0 provides default values for groups in gids 
[gVars.0.publicVars]
  VAR_PUB = 1024
  VAR_DUP_PUB = 1024

[gVars.0.protectedVars]
  VAR_HIDE = 1024
  VAR_HIDE2 = 1024

[gVars.13.publicVars]
  VAR_PUB = 'abcd'
[gVars.13.protectedVars]
  VAR_HIDE = 'def'
  VAR_DUP_PUB = 2048

# pVars.0 provides default values for Projects in pids
[pVars.0.publicVars]
  VAR_PUB = 1024
[pVars.0.protectedVars]
  VAR_HIDE = 1024

[pVars.77.publicVars]
  VAR_PUB = 2048
  VAR_77_PUB = 2048
[pVars.77.protectedVars]
  VAR_77_HIDE = 2048

Calling with package

import { loadFiles } from 'gitlab-var-helper'

const paths = [ './settings.toml' ]
loadFiless(paths)

Calling by cli

# log error
gitlab-var-helper load -f ./settings.toml
gitlab-var-helper load -f ./settings.toml -f ./other.toml
# log info
gitlab-var-helper load -f settings.toml --logLevel info

gitlab-var-helper load -f settings.toml --ignoreCert

Packages

Package Version Dependencies DevDependencies
gitlab-var-helper main-svg main-d-svg main-dd-svg
gitlab-var-helper-cli cli-svg cli-d-svg cli-dd-svg

License

MIT

Languages