Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/waitingsong/gitlab-var-helper

Batch set gitlab CI/CD variables with toml
https://github.com/waitingsong/gitlab-var-helper

cd ci environment gitlab group-level project-level runner variables

Last synced: about 1 month ago
JSON representation

Batch set gitlab CI/CD variables with toml

Host: GitHub
URL: https://github.com/waitingsong/gitlab-var-helper
Owner: waitingsong
License: mit
Created: 2019-10-29T02:10:03.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2020-12-08T08:51:26.000Z (about 4 years ago)
Last Synced: 2024-10-31T17:32:48.086Z (about 2 months ago)
Topics: cd, ci, environment, gitlab, group-level, project-level, runner, variables
Language: TypeScript
Homepage:
Size: 227 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # [gitlab-var-helper](https://waitingsong.github.io/gitlab-var-helper/)

Create and update [GitLab CI/CD environment variables] from settings file in `toml` format,

based on [gitlab-variable-helper]

[![GitHub tag](https://img.shields.io/github/tag/waitingsong/gitlab-var-helper.svg)]()

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)

![](https://img.shields.io/badge/lang-TypeScript-blue.svg)

[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)

[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lernajs.io/)

## Installation

```sh

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

  ```

2. Create `Personal Access Tokens` with `Scopes`

  - `api` 

  - `read_repository`

  - `write_repository`

3. Remember the generated `token`

  ```

  Upw_foooooooooooo

  ```

### Create settings file

```toml

# 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

```ts

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

const paths = [ './settings.toml' ]

loadFiless(paths)

```

### Calling by cli

```sh

# 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-ch] | [![main-d-svg]][main-d-link] | [![main-dd-svg]][main-dd-link] |

| [`gitlab-var-helper-cli`] | [![cli-svg]][cli-ch]   | [![cli-d-svg]][cli-d-link]   | [![cli-dd-svg]][cli-dd-link]   |

## License

[MIT](LICENSE)

### Languages

- [English](README.md)

- [中文](README.zh-CN.md)

[`gitlab-var-helper`]: https://github.com/waitingsong/gitlab-var-helper/tree/master/packages/gitlab-var-helper

[main-svg]: https://img.shields.io/npm/v/gitlab-var-helper.svg?maxAge=86400

[main-ch]: https://github.com/waitingsong/gitlab-var-helper/tree/master/packages/gitlab-var-helper/CHANGELOG.md

[main-d-svg]: https://david-dm.org/waitingsong/gitlab-var-helper.svg?path=packages/gitlab-var-helper

[main-d-link]: https://david-dm.org/waitingsong/gitlab-var-helper.svg?path=packages/gitlab-var-helper

[main-dd-svg]: https://david-dm.org/waitingsong/gitlab-var-helper/dev-status.svg?path=packages/gitlab-var-helper

[main-dd-link]: https://david-dm.org/waitingsong/gitlab-var-helper?path=packages/gitlab-var-helper#info=devDependencies

[`gitlab-var-helper-cli`]: https://github.com/waitingsong/gitlab-var-helper/tree/master/packages/gitlab-var-helper-cli

[cli-svg]: https://img.shields.io/npm/v/gitlab-var-helper-cli.svg?maxAge=86400

[cli-ch]: https://github.com/waitingsong/gitlab-var-helper/tree/master/packages/gitlab-var-helper-cli/CHANGELOG.md

[cli-d-svg]: https://david-dm.org/waitingsong/gitlab-var-helper.svg?path=packages/gitlab-var-helper-cli

[cli-d-link]: https://david-dm.org/waitingsong/gitlab-var-helper.svg?path=packages/gitlab-var-helper-cli

[cli-dd-svg]: https://david-dm.org/waitingsong/gitlab-var-helper/dev-status.svg?path=packages/gitlab-var-helper-cli

[cli-dd-link]: https://david-dm.org/waitingsong/gitlab-var-helper?path=packages/gitlab-var-helper-cli#info=devDependencies

[GitLab CI/CD environment variables]: https://docs.gitlab.com/ee/ci/variables/README.html#gitlab-cicd-environment-variables

[gitlab-variable-helper]: https://github.com/soulteary/gitlab-variable-helper