chore: ✏️ Updating package versions and README

This commit is contained in:
Justin 2020-03-22 15:13:46 +01:00
parent cedba55151
commit f48006ce26
8 changed files with 27 additions and 26 deletions

View File

@ -134,7 +134,7 @@ Available instantiating options:
The CLI export functions in a similar manner, following the pattern:
```bash
gitlab [service name] [method name] --arg1 --arg2 --arg3
gitbeaker [service name] [method name] --arg1 --arg2 --arg3
```
Where `service name` is any of the supported API names, `method name` is any of the supported commands on that API service (See source for exceptions, but generally all, show, remove, update) and `--arg1...--arg3` 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 **EXCEPT** all the optional arguments whose names should match what the GitLab API docs request.
@ -143,10 +143,10 @@ There is one small exception with the instantiating arguments, however, which mu
```bash
# To get all the projects
gitlab projects all --gb-token="personaltoken"
gitbeaker projects all --gb-token="personaltoken"
# To get a project with id = 2
gitlab projects show --gl-token="personaltoken" --projectId=2
gitbeaker projects show --gl-token="personaltoken" --projectId=2
```
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:
@ -402,7 +402,7 @@ const api = new Gitlab({
let users = await api.Users.all();
// Or using Promise-Then notation
api.Projects.all().then(projects => {
api.Projects.all().then((projects) => {
console.log(projects);
});
```

View File

@ -34,7 +34,7 @@
"lint-staged": "^10.0.8",
"prettier": "^2.0.1",
"semantic-release": "^17.0.4",
"semantic-release-npmx": "^1.0.4",
"semantic-release-npmx": "^1.1.0",
"ts-jest": "^25.2.1",
"typescript": "^3.8.3"
},
@ -52,6 +52,7 @@
"test:unit": "jest test/unit",
"commit": "git-cz --retry",
"prepublishOnly": "lerna run build",
"release": "semantic-release --no-ci --debug"
}
"release": "semantic-release --no-ci"
},
"version": "15.0.3"
}

View File

@ -1,7 +1,7 @@
{
"name": "@gitbeaker/browser",
"description": "Full Browser implementation of the GitLab API. Supports Promises, Async/Await.",
"version": "14.2.2",
"version": "15.0.3",
"author": {
"name": "Justin Dalrymple"
},
@ -9,8 +9,8 @@
"url": "https://github.com/jdalrymple/gitbeaker/issues"
},
"dependencies": {
"@gitbeaker/core": "^14.2.2",
"@gitbeaker/requester-utils": "^14.2.2",
"@gitbeaker/core": "^15.0.3",
"@gitbeaker/requester-utils": "^15.0.3",
"ky": "^0.16.2"
},
"devDependencies": {

View File

@ -1,7 +1,7 @@
{
"name": "@gitbeaker/cli",
"description": "Full NodeJS CLI implementation of the GitLab API.",
"version": "14.2.2",
"version": "15.0.3",
"author": {
"name": "Justin Dalrymple"
},
@ -12,8 +12,8 @@
"url": "https://github.com/jdalrymple/gitbeaker/issues"
},
"dependencies": {
"@gitbeaker/core": "^14.2.2",
"@gitbeaker/node": "^14.2.2",
"@gitbeaker/core": "^15.0.3",
"@gitbeaker/node": "^15.0.3",
"chalk": "^3.0.0",
"ora": "^4.0.3",
"sywac": "^1.2.2",

View File

@ -1,7 +1,7 @@
{
"name": "@gitbeaker/core",
"description": "Core API implementation of the GitLab API. Supports Promises, Async/Await.",
"version": "14.2.2",
"version": "15.0.3",
"author": {
"name": "Justin Dalrymple"
},
@ -9,7 +9,7 @@
"url": "https://github.com/jdalrymple/gitbeaker/issues"
},
"dependencies": {
"@gitbeaker/requester-utils": "^14.2.2",
"@gitbeaker/requester-utils": "^15.0.3",
"form-data": "^3.0.0",
"li": "^1.3.0",
"xcase": "^2.0.1"

View File

@ -1,7 +1,7 @@
{
"name": "@gitbeaker/node",
"description": "Full NodeJS implementation of the GitLab API. Supports Promises, Async/Await.",
"version": "14.2.2",
"version": "15.0.3",
"author": {
"name": "Justin Dalrymple"
},
@ -9,8 +9,8 @@
"url": "https://github.com/jdalrymple/gitbeaker/issues"
},
"dependencies": {
"@gitbeaker/core": "^14.2.2",
"@gitbeaker/requester-utils": "^14.2.2",
"@gitbeaker/core": "^15.0.3",
"@gitbeaker/requester-utils": "^15.0.3",
"form-data": "^3.0.0",
"got": "^10.4.0",
"xcase": "^2.0.1"

View File

@ -1,7 +1,7 @@
{
"name": "@gitbeaker/requester-utils",
"description": "Utility functions for requester implementatons used in @gitbeaker",
"version": "14.2.2",
"version": "15.0.3",
"author": {
"name": "Justin Dalrymple"
},

View File

@ -1972,9 +1972,9 @@ acorn-walk@^6.0.1:
integrity sha512-7evsyfH1cLOCdAzZAd43Cic04yKydNx0cF+7tiA19p1XnLLPU4dpCQOqpjqwokFe//vS0QqfqqjCS2JkiIs0cA==
acorn@^5.7.3:
version "5.7.3"
resolved "https://registry.yarnpkg.com/acorn/-/acorn-5.7.3.tgz#67aa231bf8812974b85235a96771eb6bd07ea279"
integrity sha512-T/zvzYRfbVojPWahDsE5evJdHb3oJoQfFbsrKM7w5Zcs++Tr257tia3BmMP8XYVjp1S9RZXQMh7gao96BlqZOw==
version "5.7.4"
resolved "https://registry.yarnpkg.com/acorn/-/acorn-5.7.4.tgz#3e8d8a9947d0599a1796d10225d7432f4a4acf5e"
integrity sha512-1D++VG7BhrtvQpNbBzovKNc1FLGGEE/oGe7b9xJm/RFHMBeUaUGpluV9RLjZa47YFdPcDAenEYuq9pQPcMdLJg==
acorn@^6.0.1:
version "6.4.0"
@ -9510,10 +9510,10 @@ saxes@^3.1.9:
dependencies:
xmlchars "^2.1.1"
semantic-release-npmx@^1.0.4:
version "1.0.4"
resolved "https://registry.yarnpkg.com/semantic-release-npmx/-/semantic-release-npmx-1.0.4.tgz#577508d590dff9e79b14d9a7685b33e4167d6edb"
integrity sha512-JWY0pMH6bbW2DWGMnX1RrfV926Vk4sKgptlvEgisP9r/LISPwhhtvqyCFN4DzKUuW2z04He13d9p/1KWSAjQaA==
semantic-release-npmx@^1.1.0:
version "1.1.0"
resolved "https://registry.yarnpkg.com/semantic-release-npmx/-/semantic-release-npmx-1.1.0.tgz#c55fbf329366c24d107e377eeaf6827229bccb70"
integrity sha512-Cxe2VJO0O2BVxKzKSOSG23Qe/mbNX5eX7K9DpbkEWt83l1j2ZswocoEPSDaPywmJVZLdO+WKDe/1Q3LwslKB6Q==
dependencies:
aggregate-error "^3.0.1"
execa "^4.0.0"