gitbeaker

mirror of https://github.com/jdalrymple/gitbeaker.git synced 2026-01-18 15:55:30 +00:00

History

Justin Dalrymple f277995994

CI/CD Re-organization and Optimization (#3515 )

- Updating CI script to use latest shutdown logic
- Removed unneeded tests
- Split browser tests into ones that need a Gitlab instance those that down
- Removing the need to run the full e2e test unless its a release branch
- Moved the most tested release tests (the exports) into a integration test since it doesnt require a full Gitlab instance for testing

2024-01-28 21:43:51 -05:00

src

Restructuring the AccessLevel enum (#3501 )

2023-12-31 15:49:10 -05:00

test

Add support for a query timeout (#3271 )

2023-05-22 00:16:22 -04:00

CHANGELOG.md

Update CHANGELOG.md [skip ci]

2023-12-31 21:19:46 +00:00

jest.config.mjs

CI/CD Re-organization and Optimization (#3515 )

2024-01-28 21:43:51 -05:00

lint-staged.config.mjs

CI/CD Re-organization and Optimization (#3515 )

2024-01-28 21:43:51 -05:00

package.json

CI/CD Re-organization and Optimization (#3515 )

2024-01-28 21:43:51 -05:00

README.md

Update contributors [skip ci]

2024-01-23 22:18:48 +00:00

tsconfig.json

CI/CD Re-organization and Optimization (#3515 )

2024-01-28 21:43:51 -05:00

README.md

^{My open source work is supported by the community}

^{Special thanks to:}

A CLI Wrapper for the @gitbeaker/rest SDK.

Usage

Node 18+

Node 18+	Install with `npm install -g @gitbeaker/cli`, or `yarn add -g @gitbeaker/cli` `gitbeaker [service name] [method name] --config_args pos_arg1 pos_argN --opts_arg1 --opts_argN # A shorthand can also be used: gb [service name] [method name] --config_args pos_arg1 pos_argN --opts_arg1 --opts_argN` Where: `service name` is any of the supported API names of the @gitbeaker/rest sdk `method name` is any of the supported commands on that API service (See source for exceptions, but generally all, show, remove, update) `--config_args` is any of general configuration arguments such as your personal token. These are outlined in this table and can also be found by looking at the cli help menu. These arguments must also include a `gb` or `gl` prefix. ie. `# To get all the projects gitbeaker projects all --gb-token="personaltoken"` `pos_arg1 ... pos_argN` are any of the arguments you would normally supply to the function. The names of the args should match the names in the method headers. These positional arguments can also be written as flag arguments: `--pos_arg1 ... --pos_argN`, BUT must be written in the correct order. `--opts_arg1 ...--opts_argN` are any of the optional arguments that you would normally supply to the function. Their names should match what the GitLab API docs request. `# To get all the projects id=2 and optional parameter "search" = "cool" gitbeaker projects all --gb-token="personaltoken" 2 --search="cool"` To reduce the annoyance of having to pass those configuration properties each time, it is also possible to pass the token and host information through environment variables in the form of `GITLAB_[option name]` or `GITBEAKER_[option name]` ie: `GITLAB_HOST=http://example.com GITLAB_TOKEN=personaltoken GITBEAKER_CAMELIZE=true` This could be set globally or using a .env file in the project folder.

Install with npm install -g @gitbeaker/cli, or yarn add -g @gitbeaker/cli

gitbeaker [service name] [method name] --config_args pos_arg1 pos_argN --opts_arg1 --opts_argN

# A shorthand can also be used:
gb [service name] [method name] --config_args pos_arg1 pos_argN --opts_arg1 --opts_argN

Where:

service name is any of the supported API names of the @gitbeaker/rest sdk
method name is any of the supported commands on that API service (See source for exceptions, but generally all, show, remove, update)
--config_args is any of general configuration arguments such as your personal token. These are outlined in this table and can also be found by looking at the cli help menu. These arguments must also include a gb or gl prefix. ie.

# To get all the projects
gitbeaker projects all --gb-token="personaltoken"

pos_arg1 ... pos_argN are any of the arguments you would normally supply to the function. The names of the args should match the names in the method headers. These positional arguments can also be written as flag arguments: --pos_arg1 ... --pos_argN, BUT must be written in the correct order.
--opts_arg1 ...--opts_argN are any of the optional arguments that you would normally supply to the function. Their names should match what the GitLab API docs request.

# To get all the projects id=2 and optional parameter "search" = "cool"
gitbeaker projects all --gb-token="personaltoken" 2 --search="cool"

To reduce the annoyance of having to pass those configuration properties each time, it is also possible to pass the token and host information through environment variables in the form of GITLAB_[option name] or GITBEAKER_[option name] ie:

GITLAB_HOST=http://example.com
GITLAB_TOKEN=personaltoken
GITBEAKER_CAMELIZE=true

This could be set globally or using a .env file in the project folder.

Contributors

This started as a fork from node-gitlab-legacy but I ended up rewriting much of the code. Here are the original work's contributors.

README.md

Table of Contents

Usage

Contributors