From eef3736c901061bc7c66b38b30cc3498a407b652 Mon Sep 17 00:00:00 2001 From: Justin Date: Wed, 9 May 2018 21:01:56 -0400 Subject: [PATCH] Readme updates, version update --- README.md | 156 ++++++++++++++++++++++++++------------------------- package.json | 2 +- 2 files changed, 82 insertions(+), 76 deletions(-) diff --git a/README.md b/README.md index 7577bfbf0..1b2430649 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -[![dependencies Status](https://david-dm.org/jdalrymple/node-gitlab-api/status.svg)](https://david-dm.org/jdalrymple/node-gitlab-api)[![devDependencies Status](https://david-dm.org/jdalrymple/node-gitlab-api/dev-status.svg)](https://david-dm.org/jdalrymple/node-gitlab-api?type=dev)[![Code Climate](https://codeclimate.com/github/jdalrymple/node-gitlab-api/badges/gpa.svg)](https://codeclimate.com/github/jdalrymple/node-gitlab-api)[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) +[![dependencies Status](https://david-dm.org/jdalrymple/node-gitlab/status.svg)](https://david-dm.org/jdalrymple/node-gitlab)[![devDependencies Status](https://david-dm.org/jdalrymple/node-gitlab/dev-status.svg)](https://david-dm.org/jdalrymple/node-gitlab?type=dev)[![Code Climate](https://codeclimate.com/github/jdalrymple/node-gitlab/badges/gpa.svg)](https://codeclimate.com/github/jdalrymple/node-gitlab)[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -[![NPM](https://nodei.co/npm/node-gitlab-api.png?downloads=true&stars=true)](https://nodei.co/npm/node-gitlab-api/) +[![NPM](https://nodei.co/npm/node-gitlab.png?downloads=true&stars=true)](https://nodei.co/npm/node-gitlab/) -# node-gitlab-api +# node-gitlab [GitLab](https://github.com/gitlabhq/gitlabhq) API NodeJS library with full support of all the [Gitlab API](https://github.com/gitlabhq/gitlabhq/tree/master/doc/api) services. @@ -30,7 +30,7 @@ ```bash # Install from npm -npm install node-gitlab-api +npm install gitlab ``` ## Usage @@ -132,7 +132,7 @@ Instantiate the library using a basic token created in your [Gitlab Profile](htt import Gitlab from 'gitlab'; // ES5 -const Gitlab = require('node-gitlab-api/dist/es5').default +const Gitlab = require('node-gitlab/dist/es5').default // Instantiating @@ -381,60 +381,66 @@ This started off as a fork from [node-gitlab](https://github.com/node-gitlab/nod ## License -[MIT](https://github.com/jdalrymple/node-gitlab-api/blob/master/LICENSE.md) +[MIT](https://github.com/jdalrymple/node-gitlab/blob/master/LICENSE.md) ## Changelog -[3.3.0](https://github.com/jdalrymple/node-gitlab-api/tags/3.3.0) (2018-5-7) +[3.3.2](https://github.com/jdalrymple/node-gitlab/tags/3.3.2) (2018-5-9) ------------------ -- Added extended support for the Jobs and Pipelines API thanks to [Isaac Ouellet Therrien](https://github.com/yonguelink) in PR [#77](https://github.com/jdalrymple/node-gitlab-api/pull/77) +- Fixing #82 +- Fixing #83 +- Updating repo name for clarity + +[3.3.0](https://github.com/jdalrymple/node-gitlab/tags/3.3.0) (2018-5-7) +------------------ +- Added extended support for the Jobs and Pipelines API thanks to [Isaac Ouellet Therrien](https://github.com/yonguelink) in PR [#77](https://github.com/jdalrymple/node-gitlab/pull/77) - Updated packages -[3.2.2](https://github.com/jdalrymple/node-gitlab-api/tags/3.2.2) (2018-5-2) +[3.2.2](https://github.com/jdalrymple/node-gitlab/tags/3.2.2) (2018-5-2) ------------------ - Fixed missing Version API -[3.2.1](https://github.com/jdalrymple/node-gitlab-api/tags/3.2.1) (2018-4-23) +[3.2.1](https://github.com/jdalrymple/node-gitlab/tags/3.2.1) (2018-4-23) ------------------ - Fixed incorrectly named bundles -[3.2.0](https://github.com/jdalrymple/node-gitlab-api/tags/3.2.0) (2018-4-21) +[3.2.0](https://github.com/jdalrymple/node-gitlab/tags/3.2.0) (2018-4-21) ------------------ -- Completed ProjectPipeline Support in PR [#72](https://github.com/jdalrymple/node-gitlab-api/pull/72) thanks to [Frédéric Boutin](https://github.com/fboutin-pmc) +- Completed ProjectPipeline Support in PR [#72](https://github.com/jdalrymple/node-gitlab/pull/72) thanks to [Frédéric Boutin](https://github.com/fboutin-pmc) -[3.1.1](https://github.com/jdalrymple/node-gitlab-api/tags/3.1.1) (2018-4-17) +[3.1.1](https://github.com/jdalrymple/node-gitlab/tags/3.1.1) (2018-4-17) ------------------ - Fixed missing UserCustomAttributes export -[3.1.0](https://github.com/jdalrymple/node-gitlab-api/tags/3.1.0) (2018-4-16) +[3.1.0](https://github.com/jdalrymple/node-gitlab/tags/3.1.0) (2018-4-16) ------------------ -- Added addTimeEstimate, addTimeSpent, timeStats, resetTimeSpent and resetTimeEstimate to the Issues API. Requested in Issue [#68](https://github.com/jdalrymple/node-gitlab-api/issues/68) -- Added XMLHttpRequest Support PR [#59](https://github.com/jdalrymple/node-gitlab-api/pull/59) +- Added addTimeEstimate, addTimeSpent, timeStats, resetTimeSpent and resetTimeEstimate to the Issues API. Requested in Issue [#68](https://github.com/jdalrymple/node-gitlab/issues/68) +- Added XMLHttpRequest Support PR [#59](https://github.com/jdalrymple/node-gitlab/pull/59) **Breaking Change** - Renamed timeEstimate to addTimeEstimate, and timeSpend to addTimeSpent, in the MergeRequests API -[3.0.4](https://github.com/jdalrymple/node-gitlab-api/tags/3.0.4) (2018-4-13) +[3.0.4](https://github.com/jdalrymple/node-gitlab/tags/3.0.4) (2018-4-13) ------------------ -- Fixed endpoint for MergeRequestNotes thanks to [Ev Haus](https://github.com/EvHaus) in PR [#63](https://github.com/jdalrymple/node-gitlab-api/pull/63) -- Fixed Commits.editStatus method thanks to [zhao0](https://github.com/zhao0) in PR [#65](https://github.com/jdalrymple/node-gitlab-api/pull/65) +- Fixed endpoint for MergeRequestNotes thanks to [Ev Haus](https://github.com/EvHaus) in PR [#63](https://github.com/jdalrymple/node-gitlab/pull/63) +- Fixed Commits.editStatus method thanks to [zhao0](https://github.com/zhao0) in PR [#65](https://github.com/jdalrymple/node-gitlab/pull/65) -[3.0.3](https://github.com/jdalrymple/node-gitlab-api/tags/3.0.3) (2018-4-5) +[3.0.3](https://github.com/jdalrymple/node-gitlab/tags/3.0.3) (2018-4-5) ------------------ - Fixed the problem with the validation of Event resource options -[3.0.0](https://github.com/jdalrymple/node-gitlab-api/tags/3.0.0) (2018-4-2) +[3.0.0](https://github.com/jdalrymple/node-gitlab/tags/3.0.0) (2018-4-2) ------------------ - Exporting all services seperatly ie. const { Projects } from 'gitlab'; as well as the usual default export: const Gitlab from 'gitlab' - Exporting bunbles which are groups of related API's. These include: ProjectsBundle, UsersBundle and GroupsBundle - Added events support to the Projects, and Users - Added full support for ProjectVariables and GroupVariables - Added support for Events. This is also exposed in Projects and Users under the events function -- Fixed the missing options parameter for the ProjectMembers and GroupMemebers APIs in PR [#45](https://github.com/jdalrymple/node-gitlab-api/pull/45) thanks to [Stefan Hall](https://github.com/Marethyu1) +- Fixed the missing options parameter for the ProjectMembers and GroupMemebers APIs in PR [#45](https://github.com/jdalrymple/node-gitlab/pull/45) thanks to [Stefan Hall](https://github.com/Marethyu1) - Supporting both camelCase and snake_case option properties: `projects.all({perPage:5}) === projects.all({per_page: 5})` - Fixed problem with .all() functions where only the some of the results were being returned -- Completed support for all Gitlab APIs, [#49](https://github.com/jdalrymple/node-gitlab-api/pull/49), [#53](https://github.com/jdalrymple/node-gitlab-api/pull/53) +- Completed support for all Gitlab APIs, [#49](https://github.com/jdalrymple/node-gitlab/pull/49), [#53](https://github.com/jdalrymple/node-gitlab/pull/53) ### Breaking Changes between 2.2.6 and 3.0.0 - Instantiation of the API must use the new operator consistently. See usage above. @@ -467,54 +473,54 @@ Runners = ProjectRunners + Runners. ProjectId is optional for all() ``` -[2.2.8](https://github.com/jdalrymple/node-gitlab-api/tags/2.2.7) (2018-4-1) +[2.2.8](https://github.com/jdalrymple/node-gitlab/tags/2.2.7) (2018-4-1) ------------------ - Updating babel -[2.2.7](https://github.com/jdalrymple/node-gitlab-api/tags/2.2.7) (2018-3-15) +[2.2.7](https://github.com/jdalrymple/node-gitlab/tags/2.2.7) (2018-3-15) ------------------ - Fixing babel runtime -[2.2.6](https://github.com/jdalrymple/node-gitlab-api/tags/2.2.6) (2018-3-15) +[2.2.6](https://github.com/jdalrymple/node-gitlab/tags/2.2.6) (2018-3-15) ------------------ - Fixed more issues within the url concatenation -[2.2.5](https://github.com/jdalrymple/node-gitlab-api/tags/2.2.5) (2018-3-15) +[2.2.5](https://github.com/jdalrymple/node-gitlab/tags/2.2.5) (2018-3-15) ------------------ - Fixed #48 - Problem with trailing `\` in url -[2.2.4](https://github.com/jdalrymple/node-gitlab-api/ce7f17693168b5dec3b36eb1d5ab796c9374613f) (2018-2-3) +[2.2.4](https://github.com/jdalrymple/node-gitlab/ce7f17693168b5dec3b36eb1d5ab796c9374613f) (2018-2-3) ------------------ - Fixed #33 - Bug within the es5 transpilling configuration -- Fixed the missing options for tags.all [#40](https://github.com/jdalrymple/node-gitlab-api/pull/40) -- Added delete key method to UserKeys.js [#41](https://github.com/jdalrymple/node-gitlab-api/pull/41) thanks to [Claude Abounegm](https://github.com/claude-abounegm) +- Fixed the missing options for tags.all [#40](https://github.com/jdalrymple/node-gitlab/pull/40) +- Added delete key method to UserKeys.js [#41](https://github.com/jdalrymple/node-gitlab/pull/41) thanks to [Claude Abounegm](https://github.com/claude-abounegm) -[2.2.3](https://github.com/jdalrymple/node-gitlab-api/ce7f17693168b5dec3b36eb1d5ab796c9374613f) (2018-2-3) +[2.2.3](https://github.com/jdalrymple/node-gitlab/ce7f17693168b5dec3b36eb1d5ab796c9374613f) (2018-2-3) ------------------ - Fixed #37 - Bug within the customAttributes logic -[2.2.2](https://github.com/jdalrymple/node-gitlab-api/ca1906879d869bf5b9aca0b2f64e46c89f3b5f4f) (2018-1-24) +[2.2.2](https://github.com/jdalrymple/node-gitlab/ca1906879d869bf5b9aca0b2f64e46c89f3b5f4f) (2018-1-24) ------------------ - Fixing bug with the version support -[2.2.1](https://github.com/jdalrymple/node-gitlab-api/e864064c98feda59d594d77b67f7d0657db78700) (2018-1-23) +[2.2.1](https://github.com/jdalrymple/node-gitlab/e864064c98feda59d594d77b67f7d0657db78700) (2018-1-23) ------------------ - Added support for the Version API through version.show() -[2.2.0](https://github.com/jdalrymple/node-gitlab-api/96e414a75ad97e88ecaaff15a6c1409a9e27b963) (2018-1-18) +[2.2.0](https://github.com/jdalrymple/node-gitlab/96e414a75ad97e88ecaaff15a6c1409a9e27b963) (2018-1-18) ------------------ -- Fixed the missing options parameter for the ProjectRepositoryCommitComment's model thanks to [Martin Benninger](https://github.com/MartinBenninger) in PR [#21](https://github.com/jdalrymple/node-gitlab-api/pull/21) -- Removal of the left over debug console.logs's within project issues again by [Martin Benninger](https://github.com/MartinBenninger) in PR [#21](https://github.com/jdalrymple/node-gitlab-api/pull/22) +- Fixed the missing options parameter for the ProjectRepositoryCommitComment's model thanks to [Martin Benninger](https://github.com/MartinBenninger) in PR [#21](https://github.com/jdalrymple/node-gitlab/pull/21) +- Removal of the left over debug console.logs's within project issues again by [Martin Benninger](https://github.com/MartinBenninger) in PR [#21](https://github.com/jdalrymple/node-gitlab/pull/22) - Added proper docs for ProjectRepositoryFiles, enabled default urlEncoding for the passed in file paths and also documented -how to run locally via npm linking for Development testing thanks to [Adam Dehnel](https://github.com/arsdehnel) in [PR #23](https://github.com/jdalrymple/node-gitlab-api/pull/23) -- Exposed the Merge Requests resource which was missing from the exports list thanks to [fewieden](https://github.com/fewieden) in [PR #26](https://github.com/jdalrymple/node-gitlab-api/pull/26) -- Added support for the Project Enviroments API and the Project Jobs API thanks to [Jeff Pelton](https://github.com/comster) in [PR #28](https://github.com/jdalrymple/node-gitlab-api/pull/28) +how to run locally via npm linking for Development testing thanks to [Adam Dehnel](https://github.com/arsdehnel) in [PR #23](https://github.com/jdalrymple/node-gitlab/pull/23) +- Exposed the Merge Requests resource which was missing from the exports list thanks to [fewieden](https://github.com/fewieden) in [PR #26](https://github.com/jdalrymple/node-gitlab/pull/26) +- Added support for the Project Enviroments API and the Project Jobs API thanks to [Jeff Pelton](https://github.com/comster) in [PR #28](https://github.com/jdalrymple/node-gitlab/pull/28) - Fixing parse function to handle encoded urls that don't include '/' such as in groups #24 ### Breaking Changes between 2.1.0 and 2.2.0 - Fixed a problem with the get responses where the response contained the full request response and not just the body -[2.1.0](https://github.com/jdalrymple/node-gitlab-api/0ea73235e0b465a0d4717a7e1f33251b58777b60) (2017-12-15) +[2.1.0](https://github.com/jdalrymple/node-gitlab/0ea73235e0b465a0d4717a7e1f33251b58777b60) (2017-12-15) ------------------ - Added es5 support and clarified the default supported versions of node (>=8.0.0 for default) - Updating project docs for consistency @@ -533,7 +539,7 @@ how to run locally via npm linking for Development testing thanks to [Adam Dehne - Removed unused labels endpoint since it already exists under projects.labels -[2.0.1-rc.1](https://github.com/jdalrymple/node-gitlab-api/62a4d360f0ca2cd584caf852d96ced3761992072) (2017-11-29) +[2.0.1-rc.1](https://github.com/jdalrymple/node-gitlab/62a4d360f0ca2cd584caf852d96ced3761992072) (2017-11-29) ------------------ - Updating pagination changes into v2.0.1 - Removed unused labels endpoint since it already exists under projects.labels @@ -545,23 +551,23 @@ accepting merge requests, cancelling merges when the pipeline succeeds, listing - Added the ability to post a status to a specific commit to the Project class -[1.3.3](https://github.com/jdalrymple/node-gitlab-api/b8a3db4a4aaf9482fb3905883d92d940babfb461) (2017-11-29) +[1.3.3](https://github.com/jdalrymple/node-gitlab/b8a3db4a4aaf9482fb3905883d92d940babfb461) (2017-11-29) ------------------ - Adding pagination to project pipelines thanks to [Tamás Török-Vistai](https://github.com/tvtamas) -[2.0.0-rc.2](https://github.com/jdalrymple/node-gitlab-api/62a4d360f0ca2cd584caf852d96ced3761992072) (2017-11-28) +[2.0.0-rc.2](https://github.com/jdalrymple/node-gitlab/62a4d360f0ca2cd584caf852d96ced3761992072) (2017-11-28) ------------------ - Updating all recent core changes into v2.0.0 -[1.3.2](https://github.com/jdalrymple/node-gitlab-api/87e3d4b0a9616c19d69e3d6213c196948240d93e) (2017-11-28) +[1.3.2](https://github.com/jdalrymple/node-gitlab/87e3d4b0a9616c19d69e3d6213c196948240d93e) (2017-11-28) ------------------ - Adding default values for the BaseModel options parameter. -[1.3.1](https://github.com/jdalrymple/node-gitlab-api/ba80ac10e1e08176da7a3a9848758a989a7199dd) (2017-11-27) +[1.3.1](https://github.com/jdalrymple/node-gitlab/ba80ac10e1e08176da7a3a9848758a989a7199dd) (2017-11-27) ------------------ - Fixed broken argument reference in the showFile and showFileRaw functions. -[2.0.0-rc.1](https://github.com/jdalrymple/node-gitlab-api/7246896c7bad7b238179109d1d6a391b0c2ef302) (2017-11-25) +[2.0.0-rc.1](https://github.com/jdalrymple/node-gitlab/7246896c7bad7b238179109d1d6a391b0c2ef302) (2017-11-25) ------------------ - Updated project docs for clarity - Cleaned up many linting problems within the class models @@ -579,56 +585,56 @@ accepting merge requests, cancelling merges when the pipeline succeeds, listing - Updated the structure of the ProjectRepository class with commits, branches, tags and files properties. - Added contributors, showBlob and showBlobRaw functions to the ProjectRepository class -[1.3.0](https://github.com/jdalrymple/node-gitlab-api/3048a3989fabe3992044baccdab1e53257f0f379) (2017-11-25) +[1.3.0](https://github.com/jdalrymple/node-gitlab/3048a3989fabe3992044baccdab1e53257f0f379) (2017-11-25) ------------------ - Extending the Groups API, see docs for a full overview. -[1.2.0](https://github.com/jdalrymple/node-gitlab-api/b08779a321fb25668df1e0f7e001394679cc47ba) (2017-11-25) +[1.2.0](https://github.com/jdalrymple/node-gitlab/b08779a321fb25668df1e0f7e001394679cc47ba) (2017-11-25) ------------------ -- Adding fix to the API constructor to include the [missing oauthToken](https://github.com/jdalrymple/node-gitlab-api/pulls?q=is%3Apr+is%3Aclosed) thanks to [Salim Benabbou](https://github.com/Salimlou). -- Updated some of the outdated gitlab repository file endpoints outlined in [Issue #11](https://github.com/jdalrymple/node-gitlab-api/issues/11): [showFile](https://docs.gitlab.com/ee/api/repository_files.html#get-file-from-repository), [updateFile](https://docs.gitlab.com/ee/api/repository_files.html#update-existing-file-in-repository), and [createFile](https://docs.gitlab.com/ee/api/repository_files.html#create-new-file-in-repository). Also added [deleteFile](https://docs.gitlab.com/ee/api/repository_files.html#delete-existing-file-in-repository) and [showRawFile](https://docs.gitlab.com/ee/api/repository_files.html#get-raw-file-from-repository). +- Adding fix to the API constructor to include the [missing oauthToken](https://github.com/jdalrymple/node-gitlab/pulls?q=is%3Apr+is%3Aclosed) thanks to [Salim Benabbou](https://github.com/Salimlou). +- Updated some of the outdated gitlab repository file endpoints outlined in [Issue #11](https://github.com/jdalrymple/node-gitlab/issues/11): [showFile](https://docs.gitlab.com/ee/api/repository_files.html#get-file-from-repository), [updateFile](https://docs.gitlab.com/ee/api/repository_files.html#update-existing-file-in-repository), and [createFile](https://docs.gitlab.com/ee/api/repository_files.html#create-new-file-in-repository). Also added [deleteFile](https://docs.gitlab.com/ee/api/repository_files.html#delete-existing-file-in-repository) and [showRawFile](https://docs.gitlab.com/ee/api/repository_files.html#get-raw-file-from-repository). - Fixing bug where many pages where attempted to be loaded on every GET request. -[1.1.4](https://github.com/jdalrymple/node-gitlab-api/328bc29fe48d1bf18c83779a214cce34e80dda09) (2017-11-17) +[1.1.4](https://github.com/jdalrymple/node-gitlab/328bc29fe48d1bf18c83779a214cce34e80dda09) (2017-11-17) ------------------ - Library maintenance, cleaning up spelling errors, updating dependencies, adding to contributors lists etc. -[1.1.3](https://github.com/jdalrymple/node-gitlab-api/6f28ce1726ce371d4b0272d5f8305080d51e3e25) (2017-11-17) +[1.1.3](https://github.com/jdalrymple/node-gitlab/6f28ce1726ce371d4b0272d5f8305080d51e3e25) (2017-11-17) ------------------ - Fixing typos in the project sharing (group_access) thanks to [Christoph Lehmann](https://github.com/christophlehmann) - Updated the ReadMe to be more clear based on suggestions from [Frank V](https://github.com/FrankV01) -[1.1.2](https://github.com/jdalrymple/node-gitlab-api/36570c32be7cd564bda9c7c7dc07059987969bd4) (2017-10-29) +[1.1.2](https://github.com/jdalrymple/node-gitlab/36570c32be7cd564bda9c7c7dc07059987969bd4) (2017-10-29) ------------------ - Updated the protected branch functionality by adding an options parameter originally proposed by [Martin Bour](https://github.com/shadygrove) - Removed old paging logic from groups - Updating library dependencies -[1.1.1](https://github.com/jdalrymple/node-gitlab-api/67df1c8772614b3856f2995eaa7d260d0f697e49) (2017-09-24) +[1.1.1](https://github.com/jdalrymple/node-gitlab/67df1c8772614b3856f2995eaa7d260d0f697e49) (2017-09-24) ------------------ - Patch, fixed a broken pagination property - Adding in missing options parameter in the groups API thanks to a pull request from [Cory Zibell](https://github.com/coryzibell) -[1.1.0](https://github.com/jdalrymple/node-gitlab-api/385ef9f351981f26180e1381525ade458bcde1cd) (2017-09-24) +[1.1.0](https://github.com/jdalrymple/node-gitlab/385ef9f351981f26180e1381525ade458bcde1cd) (2017-09-24) ------------------ - Adding proper pagination support thanks to a problem noticed by [Mike Wyatt](https://github.com/mikew) -[1.0.14](https://github.com/jdalrymple/node-gitlab-api/b8fb74828503f0a6432376ad156b7f9e33f6228e) (2017-08-1) +[1.0.14](https://github.com/jdalrymple/node-gitlab/b8fb74828503f0a6432376ad156b7f9e33f6228e) (2017-08-1) ------------------ - Adding default file name for file uploads. If none is supplied, the file name is inferred from the file path -[1.0.13](https://github.com/jdalrymple/node-gitlab-api/3eb244a5b487f487859f750e46c8fa287b4455c4) (2017-07-31) +[1.0.13](https://github.com/jdalrymple/node-gitlab/3eb244a5b487f487859f750e46c8fa287b4455c4) (2017-07-31) ------------------ - Fixed another bug in the project file upload functionality -[1.0.12](https://github.com/jdalrymple/node-gitlab-api/commit/6f77ee0a462a19ae65bd6206eb94c72e271ba673) (2017-07-30) +[1.0.12](https://github.com/jdalrymple/node-gitlab/commit/6f77ee0a462a19ae65bd6206eb94c72e271ba673) (2017-07-30) ------------------ - Added issue links (for related issues) - Fixed project file upload -[1.0.11](https://github.com/jdalrymple/node-gitlab-api/commit/af4eb6955f583b5be4a4032d2d532d81bb2cf54d) (2017-07-20) +[1.0.11](https://github.com/jdalrymple/node-gitlab/commit/af4eb6955f583b5be4a4032d2d532d81bb2cf54d) (2017-07-20) ------------------ - Fixing the problem where Id was used instead of IId's for Project issues - Fixing the naming convention for Project Issues @@ -636,51 +642,51 @@ inferred from the file path - Removed instances of duplicate code found by code climate -[1.0.10](https://github.com/jdalrymple/node-gitlab-api/commit/c4a55aba89d83fda1552b3d5688b090b0c2b60aa) (2017-07-13) +[1.0.10](https://github.com/jdalrymple/node-gitlab/commit/c4a55aba89d83fda1552b3d5688b090b0c2b60aa) (2017-07-13) ------------------ -- Fixing Issues [#1](https://github.com/jdalrymple/node-gitlab-api/pull/1), [#2](https://github.com/jdalrymple/node-gitlab-api/pull/3), and [#3](https://github.com/jdalrymple/node-gitlab-api/pull/3) +- Fixing Issues [#1](https://github.com/jdalrymple/node-gitlab/pull/1), [#2](https://github.com/jdalrymple/node-gitlab/pull/3), and [#3](https://github.com/jdalrymple/node-gitlab/pull/3) -[1.0.9](https://github.com/jdalrymple/node-gitlab-api/commit/7a90dbb6354fe956fff37c56f938a833e3fc5ea1) (2017-07-06) +[1.0.9](https://github.com/jdalrymple/node-gitlab/commit/7a90dbb6354fe956fff37c56f938a833e3fc5ea1) (2017-07-06) ------------------ - Fixing broken Notes API reference - Added Project triggers, members and hooks docs - Moved Project Runners into its own scope and separated out general Runners API logic -[1.0.8](https://github.com/jdalrymple/node-gitlab-api/commit/491a707624ba9f58818014eacfeb7182b8ecf800) (2017-06-30) +[1.0.8](https://github.com/jdalrymple/node-gitlab/commit/491a707624ba9f58818014eacfeb7182b8ecf800) (2017-06-30) ------------------ - Adding more to the Project Issue Notes API - Updating Readme to show examples of connecting with OAuth tokens - Begun adding documentation for projects -[1.0.7](https://github.com/jdalrymple/node-gitlab-api/commit/50642ad764ecd20d2a9e279cf2a47e7b5efe8f07) (2017-06-23) +[1.0.7](https://github.com/jdalrymple/node-gitlab/commit/50642ad764ecd20d2a9e279cf2a47e7b5efe8f07) (2017-06-23) ------------------ - Fixing bug within the Issues API; reference to an old function. -[1.0.6](https://github.com/jdalrymple/node-gitlab-api/commit/2b02d1e354c1c267683d10b893ad055fe856a214) (2017-06-23) +[1.0.6](https://github.com/jdalrymple/node-gitlab/commit/2b02d1e354c1c267683d10b893ad055fe856a214) (2017-06-23) ------------------ - Fixing bug within the Labels API; Missing required argument. -[1.0.5](https://github.com/jdalrymple/node-gitlab-api/commit/03a22b46a62d7b68937575b0b74b6fd3496f7cbf) (2017-06-23) +[1.0.5](https://github.com/jdalrymple/node-gitlab/commit/03a22b46a62d7b68937575b0b74b6fd3496f7cbf) (2017-06-23) ------------------ - Fixing bug within the delete API calls. It was missing query parameters -[1.0.4](https://github.com/jdalrymple/node-gitlab-api/commit/9d9ef2615c6dd778a3fb1c6140d5ce009c421bb1) (2017-06-23) +[1.0.4](https://github.com/jdalrymple/node-gitlab/commit/9d9ef2615c6dd778a3fb1c6140d5ce009c421bb1) (2017-06-23) ------------------ - Adding more to the Labels API - Cleaned up the Issues class -[1.0.3](https://github.com/jdalrymple/node-gitlab-api/commit/fe5a5fbb8d01fb670b7c7b14ce2c5b7f30d71fe5) (2017-06-23) +[1.0.3](https://github.com/jdalrymple/node-gitlab/commit/fe5a5fbb8d01fb670b7c7b14ce2c5b7f30d71fe5) (2017-06-23) ------------------ - Updating problems within the Milestone API - Removed the old 'list' calls for projects and issues which displayed a deprecated message. Only all is available now. -[1.0.2](https://github.com/jdalrymple/node-gitlab-api/commit/a295d5a613efa13be79fec5fa2835076047cdcc5) (2017-06-22) +[1.0.2](https://github.com/jdalrymple/node-gitlab/commit/a295d5a613efa13be79fec5fa2835076047cdcc5) (2017-06-22) ------------------ - Updating examples in ReadMe - Adding dependency badges - Removing unused test files -[1.0.1](https://github.com/jdalrymple/node-gitlab-api/commit/64a8f8c7720f5df9a67d3f26cc8712fc21eb3ac0) (2017-06-21) +[1.0.1](https://github.com/jdalrymple/node-gitlab/commit/64a8f8c7720f5df9a67d3f26cc8712fc21eb3ac0) (2017-06-21) ------------------ - Initial release - TODO: Tests, Examples @@ -690,18 +696,18 @@ inferred from the file path To get this running locally rather than from your `node_modules` folder: ```bash -$ git clone https://github.com/jdalrymple/node-gitlab-api.git -$ cd node-gitlab-api +$ git clone https://github.com/jdalrymple/node-gitlab.git +$ cd node-gitlab $ npm install $ npm build ``` -And then inside whatever project you are using `node-gitlab-api` in you change your references to use that repo. In your package.json of that upstream project change: +And then inside whatever project you are using `node-gitlab` in you change your references to use that repo. In your package.json of that upstream project change: ```json "dependencies": { ... - "node-gitlab-api": "2.1.0" + "node-gitlab": "2.1.0" ... } ``` @@ -711,7 +717,7 @@ to this ```json "dependencies": { ... - "node-gitlab-api": "" + "node-gitlab": "" ... } ``` diff --git a/package.json b/package.json index 6cac71a03..116cf5cc4 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "gitlab", - "version": "3.3.0", + "version": "3.3.2", "description": "Full NodeJS implementation of the GitLab API. Supports Promises, Async/Await.", "main": "dist/latest/index.js", "engines": {