Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sgaunet/gitlab-vars
Tool to get the environment variables of a gitlab project or gitlab group.
https://github.com/sgaunet/gitlab-vars
gitlab project variables
Last synced: 26 days ago
JSON representation
Tool to get the environment variables of a gitlab project or gitlab group.
- Host: GitHub
- URL: https://github.com/sgaunet/gitlab-vars
- Owner: sgaunet
- License: mit
- Created: 2023-02-10T20:27:12.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-29T15:25:08.000Z (3 months ago)
- Last Synced: 2024-09-28T09:04:06.892Z (about 1 month ago)
- Topics: gitlab, project, variables
- Language: Go
- Homepage:
- Size: 63.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://goreportcard.com/report/github.com/sgaunet/gitlab-vars)
[](https://github.com/sgaunet/gitlab-vars/releases/latest)
[](https://goreportcard.com/report/github.com/sgaunet/gitlab-vars)
[](https://codeclimate.com/github/sgaunet/gitlab-vars/maintainability)
[](https://godoc.org/github.com/sgaunet/gitlab-vars)
[](LICENSE)
# gitlab-vars
Tool to get the environment variables of a gitlab project or gitlab group.
* This tool does not initiliaze the [predefinid variables.](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html)
* It does not care of variables declared in .gitlab-ci.yml file
* But you can simulate some vars by creating a .gitlab-vars.json file (see below)
```
Usage: gitlab-vars [options]
Options:
-g Group id
-p Project id
-e Environment
-h Help
-d Debug level (info, error, debug)
-v Version
gitlab-vars is a tool to print the variables of a gitlab project. You can use it to check how variables will be overrided.
But don't expect from this tool to give you the value of the variables after a workflow for example.
It won't read .gitlab-ci.yml file.
Every parameters are optionals.
By default, gitlab-vars try to find the project id from the current git repository.
How it works ?
1. Find the .git directory
2. Read the git config file
3. Get the remote origin url
4. Find the project id from the remote origin url
If the project id is not found, you can specify the group id or the project id.
```
# Install
Copy the binary to /usr/local/bin for example. (or another directory which is in your PATH).
## Configuration
2 environment variables can be set :
* GITLAB_TOKEN: used to access to the gitlab API
* GITLAB_URI: to specify another instance of Gitlab (if not set, GITLAB_URI is set to https://gitlab.com)
# Examples
## print variables of the current gitlab project (where the project has been cloned)
```
$ git clone [email protected]:group/awesome-project.git
$ cd awesome-project
$ gitlab-vars
```
## get variables of a gitlab group
```
gitlab-vars -g XXXXXX
```
## get variables of a gitlab project
```
gitlab-vars -p XXXXXX
```
## get variables of a gitlab project
```
cd .../gitlab-cloned-project
gitlab-vars
```
## Filter for a specific env
```
cd .../gitlab-cloned-project
gitlab-vars -e production
```
## Add some vars with .gitlab-vars.json
```
cat > .gitlab-vars.json < tmpl.out
$ ls
tmpl t.sh
$ bash t.sh
$ cat tmpl.out
registry.gitlab.com
```