gitbeaker/CHANGELOG.md
semantic-release-bot edefb680e7 chore(release): 10.0.0 [skip ci]
# [10.0.0](https://github.com/jdalrymple/node-gitlab/compare/9.1.0...10.0.0) (2019-07-15)

### Code Refactoring

* Adding required labelName and colour option to the create method ([199e32d](https://github.com/jdalrymple/node-gitlab/commit/199e32d))

### BREAKING CHANGES

* Labels require a colour and a name to be created. Now the create method takes a second and third argument: 'labelName' and 'color'
2019-07-15 14:44:32 +00:00

47 KiB

10.0.0 (2019-07-15)

Code Refactoring

  • Adding required labelName and colour option to the create method (199e32d)

BREAKING CHANGES

  • Labels require a colour and a name to be created. Now the create method takes a second and third argument: 'labelName' and 'color'

9.1.0 (2019-07-12)

Features

  • Adding support for branchName key seen in the Gitlab API v3 (356466f)

9.0.1 (2019-07-11)

Bug Fixes

  • Accept any variables that begin with uppercase letters and include an underscore #254 (fe39590)

9.0.0 (2019-07-04)

Bug Fixes

Code Refactoring

  • Standardizing the upload argument header (aa33061)

BREAKING CHANGES

  • path argument is no longer required/available. Now, it follows a similar function header to Project.upload with an optional metadata argument Missing dependency dede

8.0.0 (2019-07-03)

Bug Fixes

  • PushRules were missing from the ProjectBundle export and the README. #373 (f7425a7)

BREAKING CHANGES

  • PushRule export was renamed to PushRules to match the plurality of the export names

7.0.1 (2019-07-01)

Bug Fixes

  • Revert support for the rejectUnauthorized option until issues in #377 are sorted. (f9a47c7)

7.0.0 (2019-06-28)

Features

  • Adding missing endpoints for deploy keys #373 (b23dd29)

BREAKING CHANGES

  • all method now takes an optional object since projectId is no longer required. If no projectId is passed, the all method returns all deploy keys across all projects of the GitLab instance

6.4.0 (2019-06-28)

Bug Fixes

  • Handle body types properly if not JSON ie formData (a135841), closes #355
  • Missing headers when posting json data (861f89e)
  • Use the correct agent configuration for the rejectUnauthorized option (775d755), closes #357

Features

  • Adding support for Group Issues (00068c9), closes #306

6.3.7 (2019-06-12)

Bug Fixes

6.3.6 (2019-06-12)

Bug Fixes

  • Use improved pagination regex to remove service url + leaf (2b290b5), closes #352

6.3.5 (2019-06-12)

Bug Fixes

  • Fix error due to Typescript 3.5.1 (bd4e141)
  • Fix error due to Typescript 3.5.1 (5474f06)
  • Make package Typescript-conformant (da1a8f6)
  • Update Typescript to 3.5.1 (8f5fec5)

6.3.4 (2019-06-11)

Bug Fixes

  • Wrong endpoint being passed during pagination (a2a6126), closes #344

6.3.3 (2019-06-10)

Bug Fixes

  • Handle edge cases where content-type headers are missing or the content text is null (dabcb3d), closes #343

6.3.2 (2019-06-10)

Bug Fixes

  • Moving the error wrapper for the Ky Requester to be only around the Ky function request. Also checking to see if the error contains a response before looking for an error message. (a54a6ae), closes #343

6.3.1 (2019-06-10)

Bug Fixes

  • Resource Discussion API was using the incorrect url to add a note (#345) (c6ff86d), closes #342

6.3.0 (2019-06-08)

Features

6.2.0 (2019-06-07)

Features

  • Adding support for Container Registry API #274 (59f9286)

6.1.0 (2019-06-06)

Bug Fixes

Features

  • Adding support for ReleaseLinks API (d6a2248)
  • Adding support for Releases API #295 (7191e81)

6.0.0 (2019-06-02)

Code Refactoring

  • RepositoryFiles: Missing a required argument from the function headers (e13c593)

BREAKING CHANGES

  • RepositoryFiles: create, edit and remove functions now require the commitMessage function argument

5.0.2 (2019-05-31)

Bug Fixes

  • Properly handling the response bodies returned from gitlab (881b87b), closes #320

5.0.1 (2019-05-26)

Bug Fixes

  • package: Making lint-staged a dev dependency (5c949b2)
  • package: Missing dependency (40f5d21)

5.0.0 (2019-05-25)

Bug Fixes

  • #227 Fixing array syntax thanks to Lukas Eipert (https://github.com/leipert) (aa6acb1)
  • Fixing Todos support. If todoId was not passed, an undefined value would be introduced into the url (cea5a2b)
  • Fixing typing structure and configuration (a79dabe)
  • Merge Request Approvals API did not match official API (e4ba731)
  • Removed xhr library in favour of ky, and switched request for got for a smaller package size and retry functionality (ee4730f)
  • ResourceAwardEmojis API wasn't properly filtering based on awardId (a7b29c1)

Code Refactoring

  • Expose optional parameters for the NotiicationSettings API (1ba9126)
  • Removed Fs dependency for better browser support (037f4ed)
  • Removed inconsistent export strategies (03e85ef)
  • Removed the confusing url parameter from BaseService (26e2e52)
  • Requiring content for the Note related APIs (7453779)
  • Similar to the RepositoryFiles API changes (97dd060)
  • SystemHooks API function header updates (6ea90d3)
  • Triggers API required arguments exposed as optional (62e032b)
  • Updating the MergeRequest API's pipeline function header (46a541b)

Features

  • Added LDAP support to the Groups API (3f6d409)
  • Added the ability to add sudo to specific requests (18effa2)
  • Added the missing edit function to the Groups API (ee6d490)
  • Adding the option to conditionally camelize response body (5f97193)

BREAKING CHANGES

  • Triggers API pipeline function requires the ref and token
  • Notes now require a body argument
  • NotificationSettings API edit function now takes one parameter, options
  • MergeRequest Pipelines require the mergeRequestId
  • Updated Approvals API support to match https://docs.gitlab.com/ee/api/merge_request_approvals.html
  • Removed dependency on FS. Now the Projects API takes in two arguments projectId and content as well as an option fileName argument
  • Removed projectId from System Hooks API since it wasn't required
  • Added content as a required parameter for RepositoryFiles
  • Changing everything to named exports for simplicity
  • Switching required initialization argument from 'url' to 'host'

4.5.1 (2019-03-22)

Bug Fixes

4.5.0 (2019-03-19)

Features

  • Updated MergeRequests API options (a306799)

4.4.1 (2019-03-06)

Features

  • Projects:

    • Add support for DELETE /projects/:id/fork (ef53a2)
  • MergeRequests:

    • Add MergeRequest.participants request (b11a4f)
  • Triggers:

    • Add missing method for triggering pipelines (5858fc)

Bug Fixes

  • Add missing / from unshare in Projects (6fb7f5)
  • Change lint api url. (1d6e6e)
  • Implement jobToken property to allow authentication via CI job token (8f551f)

Docs

  • Update README.md with rejectUnauthorized
  • Fixing typo in the host url

4.3.0 (2018-12-12)

Breaking

  • Added content as a required parameter for RepositoryFiles
  • Removed projectId from System Hooks API since it wasn't required
  • Removed dependency on FS. Now the Projects API takes in two arguments projectId and content as well as an option fileName argument
  • Changing everything to named exports for simplicity
  • Switching required initialization argument from 'url' to 'host'
  • Updated Approvals API support to match https://docs.gitlab.com/ee/api/merge_request_approvals.html
  • MergeRequest Pipelines require the mergeRequestId
  • NotificationSettings API edit function now takes one parameter, options
  • Changing the access level enum property from master to maintainer as per https://gitlab.com/gitlab-org/gitlab-ce/issues/42751
  • Notes now require a body argument instead of checking the options argument for a body parameter
  • Bumped min node version to > v10 LTS

Bug Fixes

Features

  • Added the ability to add sudo to specific requests (780244f (https://github.com/jdalrymple/node-gitlab/commit/780244f))
  • Added the missing edit function to the Groups API
  • Added LDAP support to the Groups API
  • Added missing method for triggering pipelines (#275)
  • Implement jobToken property to allow authentication via CI job token (#269)

Documentation

  • Removing xml request docs
  • Updating imports to be named imports

Tests

  • Fixing integration test for ApplicationSettings (#273)

4.5.1 (2019-03-22)

Bug Fixes

4.5.0 (2019-03-19)

Features

  • Updated MergeRequests API options (a306799)

4.4.1 (2019-03-06)

Features

  • Projects:

    • Add support for DELETE /projects/:id/fork (ef53a2)
  • MergeRequests:

    • Add MergeRequest.participants request (b11a4f)
  • Triggers:

    • Add missing method for triggering pipelines (5858fc)

Bug Fixes

  • Add missing / from unshare in Projects (6fb7f5)
  • Change lint api url. (1d6e6e)
  • Implement jobToken property to allow authentication via CI job token (8f551f)

Docs

  • Update README.md with rejectUnauthorized
  • Fixing typo in the host url

4.3.0 (2018-12-12)

Features

  • services: Add protected tags (8203830)

4.2.7 (2018-11-26)

Bug Fixes

  • Handing the function arguments in the incorrect order (26235ff)

4.2.6 (2018-11-26)

Bug Fixes

4.2.5 (2018-11-26)

Bug Fixes

  • Project variables urls were being generated incorrectly (28b28cf)

4.2.4 (2018-11-26)

Bug Fixes

  • Event properties using the incorrect boolean operator (5f21a46)

4.2.3 (2018-11-26)

Bug Fixes

  • Filtering all events shouldnt require an action or a target #61 (cda23b8)

4.2.1 (2018-10-29)

Bug Fixes

  • Updating application settings test to match updated API (dececa6)

4.2.0 (2018-10-10)

Bug Fixes

  • jest.config file to properly run tests again. Follow up issue to fix these exceptions (dcee7ac)

Features

4.1.1 (2018-09-25)

Bug Fixes

  • Updating ApplicationSettings test (0d345b7)

4.1.0 (2018-09-19)

Features

4.0.1 (2018-09-06)

Bug Fixes

  • Updating the package.lock (9b4b6f9)

4.0.0-beta (2018-08-22)

Major Update

  • Migration to Typescript

3.11.3 (2018-08-31)

Bug Fixes

  • Camelcasing broke the body params (e50f588)

3.11.2 (2018-08-28)

Bug Fixes

  • obey rate limits for all request types correctly (#170) (4bc7c69), closes #165
  • Testing negated npmignore (86960c4)

3.11.1 (2018-08-28)

Bug Fixes

  • applications-settings: Edit of application settings not working (#169) (f0213ca)
  • test: Application settings api updated (#177) (0723a7a)

3.11.0 (2018-08-20)

Bug Fixes

Features

  • projects: add archive/unarchive functionality (#168) (5e7b1bd), closes #166

3.10.1 (2018-08-16)

Bug Fixes

3.10.0 (2018-08-15)

Features

  • Expose reject unauthorized in request helper (#160) (01a2ce2), closes #142

3.9.0 (2018-08-15)

Bug Fixes

  • Fix error while throwing an error in RequestHelper (#156) (177d7fd)
  • Handling errors before retrying request (#142) skip-ci
  • Linting Master (#157) (ab14ed7)

Features

3.8.0 (2018-08-14)

Bug Fixes

Features

3.7.0 (2018-08-02)

Features

  • Adding update push rules to Projects, and updating the Protected Branches service to match the updated API thanks to jennparise(#134) (9f3de02)
  • Updating Project Snippets API #138 (a7858bd)

3.6.0 (2018-07-24)

Bug Fixes

Features

3.5.1 (2018-7-08)

  • Fixed migrating-from-node-gitlab link in Table of Contents #118 thanks to Quentin Dreyer
  • Fix methods for editing MR approval/approver settings #119 thanks to Norm MacLennan
  • Removed codcov patch coverage until a larger portion of the codebase is covered

3.5.0 (2018-7-04)

3.4.6 (2018-7-02)

  • Title parameter in the Project Milestones API was not being passed in the request (f1c3e1a), closes #116

3.4.5 (2018-7-02)

3.4.4 (2018-6-26)

  • Updating babel configuration thanks to a prompt from bodtx and suggestions from Logan Smyth

3.4.3 (2018-6-25)

  • Updating packages
  • Adding support for the retrieval of projects by user id #105 thanks to Michael Townsend

3.4.2 (2018-6-06)

3.4.1 (2018-6-01)

  • Seperated out changelog
  • Adding ability to view pagination information, #94, via the showPagination option
  • Adding CommitDiscussions and MergeRequestDiscussions support

3.4.0 (2018-5-24)

  • Added the first stage of testing in #71 with Adam Dehnel's guidance
  • Added jobs.show() that was missing from the Jobs service

3.3.6 (2018-5-22)

3.3.5 (2018-5-15)

3.3.4 (2018-5-14)

3.3.3 (2018-5-13)

3.3.2 (2018-5-9)

  • Fixing #82
  • Fixing #83
  • Updating repo name for clarity

3.3.0 (2018-5-7)

3.2.2 (2018-5-2)

  • Fixed missing Version API

3.2.1 (2018-4-23)

  • Fixed incorrectly named bundles

3.2.0 (2018-4-21)

3.1.1 (2018-4-17)

  • Fixed missing UserCustomAttributes export

3.1.0 (2018-4-16)

  • Added addTimeEstimate, addTimeSpent, timeStats, resetTimeSpent and resetTimeEstimate to the Issues API. Requested in Issue #68
  • Added XMLHttpRequest Support PR #59

Breaking Change

  • Renamed timeEstimate to addTimeEstimate, and timeSpend to addTimeSpent, in the MergeRequests API

3.0.4 (2018-4-13)

  • Fixed endpoint for MergeRequestNotes thanks to Ev Haus in PR #63
  • Fixed Commits.editStatus method thanks to zhao0 in PR #65

3.0.3 (2018-4-5)

  • Fixed the problem with the validation of Event resource options

3.0.0 (2018-4-2)

  • Exporting all services separately ie. const { Projects } from 'gitlab'; as well as the usual default export: const Gitlab from 'gitlab'
  • Exporting bundles 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 thanks to Stefan Hall
  • 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, #53

Breaking Changes between 2.2.6 and 3.0.0

  • Instantiation of the API must use the new operator consistently. See usage above.
  • All services being exported are not capitalized for clarity that they are themselves api's and not properties. ie. Gitlab.Projects vs Gitlab.projects
  • All subservices (services exposed as properties of other services) have been moved out into their own service
ProjectRepository -> Repositories, Tags, Commits, Branches and RepositoryFiles
Users -> Users, UserKeys, UserGPGKeys, UserCustomAttributes, UserVariables

  • Moved createTodo function from MergeRequests API to Todos API
  • Many services have been renamed:
ProjectProtectedBranches -> ProtectedBranches
ProjectDeployKeys -> DeployKeys
ProjectEnvironments -> Environments
ProjectJobs -> Jobs
ProjectLabels -> Labels
ProjectPipelines -> Pipelines
ProjectRepository -> Repositories
ProjectServices -> Services
ProjectTriggers -> Triggers
  • Some services were merged:
Issues = ProjectIssues + Issues.  ProjectId is optional for all()
MergeRequests = ProjectMergeRequests + MergeRequests + MergeRequestsChanges + MergeRequestsCommits + MergeRequestVersions. ProjectId is optional for all()
Runners = ProjectRunners + Runners. ProjectId is optional for all()

2.2.8 (2018-4-1)

  • Updating babel

2.2.7 (2018-3-15)

  • Fixing babel runtime

2.2.6 (2018-3-15)

  • Fixed more issues within the url concatenation

2.2.5 (2018-3-15)

  • Fixed #48 - Problem with trailing \ in url

2.2.4 (2018-2-3)

  • Fixed #33 - Bug within the es5 transpilling configuration
  • Fixed the missing options for tags.all #40
  • Added delete key method to UserKeys.js #41 thanks to Claude Abounegm

2.2.3 (2018-2-3)

  • Fixed #37 - Bug within the customAttributes logic

2.2.2 (2018-1-24)

  • Fixing bug with the version support

2.2.1 (2018-1-23)

  • Added support for the Version API through version.show()

2.2.0 (2018-1-18)

  • Fixed the missing options parameter for the ProjectRepositoryCommitComment's model thanks to Martin Benninger in PR #21
  • Removal of the left over debug console.logs's within project issues again by Martin Benninger in PR #21
  • 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 in PR #23
  • Exposed the Merge Requests resource which was missing from the exports list thanks to fewieden in PR #26
  • Added support for the Project Environments API and the Project Jobs API thanks to Jeff Pelton in PR #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 (2017-12-15)

  • Added es5 support and clarified the default supported versions of node (>=8.0.0 for default)
  • Updating project docs for consistency
  • Adding project unsharing to API. It was in the docs, but missing from the API
  • Updating deprecated protected branches endpoint. Previously this was projects.branches.protect now its projects.protectedBranches.protect
  • Added Owned Runners and Runner Jobs API

Breaking Changes between 1.3.3 and 2.1.0

  • The list functions are no longer supported and have all been renamed to all
  • The update functions are no longer supported and have all been renamed to edit
  • The addKey function has been renamed to add in UserKeys class
  • The deploy_keys and merge_requests properties have been renamed to deployKeys and mergeRequests
  • Removed old group member functions from the groups class as they have been moved to the GroupMembers class. This includes the addMember, listMembers, editMember, and removeMember. These functions can now be access via group.members.add, group.members.all, group.members.edit and group.members.remove respectively.
  • Removed the old group project functions from the Group class. These are now located in the GroupProject class. The functions that have been removed are listProjects, addProjects. These functions can be access by group.projects.all, and group.projects.add respectively.
  • Updated the structure of the ProjectRepository class such that its commits, branches, tags and files are properties and can be accessed like repository.commits.all() etc.
  • Removed unused labels endpoint since it already exists under projects.labels

2.0.1-rc.1 (2017-11-29)

  • Updating pagination changes into v2.0.1
  • Removed unused labels endpoint since it already exists under projects.labels
  • Added a mergeRequests class for the merge_requests endpoints
  • Extended the ProjectMergeRequests class for additional functionality that was missing for project merge requests such as accepting merge requests, canceling merges when the pipeline succeeds, listing issues that will close on merge, subscribing/unsubscribing to merges, creating todos, time spent and time estimates as well as time stats.
  • Fixed the notes endpoints for ProjectMergeRequests. This can now be access via projects.mergeRequests.notes.[command here]
  • Added comments endpoints to the ProjectRepositoryCommits class
  • Added the ability to post a status to a specific commit to the Project class

1.3.3 (2017-11-29)

2.0.0-rc.2 (2017-11-28)

  • Updating all recent core changes into v2.0.0

1.3.2 (2017-11-28)

  • Adding default values for the BaseModel options parameter.

1.3.1 (2017-11-27)

  • Fixed broken argument reference in the showFile and showFileRaw functions.

2.0.0-rc.1 (2017-11-25)

  • Updated project docs for clarity
  • Cleaned up many linting problems within the class models
  • Removed mutator operations on the options arguments
  • Renamed ProjectKeys to ProjectDeployKeys
  • Renamed list functions to all for consistency
  • Renamed update functions to edit for consistency
  • Renaming addKey just to add in UserKeys class
  • Renaming deploy_keys and merge_requests to deployKeys and mergeRequests for consistency
  • Adding Project Access Requests
  • Removing old group member functions from the groups class as they have been moved to the GroupMembers class. This includes the addMember, listMembers, editMember, and removeMember. These functions can now be access via group.members.add, group.members.all, group.members.edit and group.members.remove respectively.
  • Removed the old group project functions from the Group class. These are now located in the GroupProject class. The functions that have been removed are listProjects, addProjects. These functions can be access by group.projects.all, and group.projects.add respectively.
  • Methods in the ProjectDeployKeys class updated for consistency
  • Methods in the ProjectHooks updated for consistency
  • 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 (2017-11-25)

  • Extending the Groups API, see docs for a full overview.

1.2.0 (2017-11-25)

1.1.4 (2017-11-17)

  • Library maintenance, cleaning up spelling errors, updating dependencies, adding to contributors lists etc.

1.1.3 (2017-11-17)

  • Fixing typos in the project sharing (group_access) thanks to Christoph Lehmann
  • Updated the ReadMe to be more clear based on suggestions from Frank V

1.1.2 (2017-10-29)

  • Updated the protected branch functionality by adding an options parameter originally proposed by Martin Bour
  • Removed old paging logic from groups
  • Updating library dependencies

1.1.1 (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

1.1.0 (2017-09-24)

  • Adding proper pagination support thanks to a problem noticed by Mike Wyatt

1.0.14 (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 (2017-07-31)

  • Fixed another bug in the project file upload functionality

1.0.12 (2017-07-30)

  • Added issue links (for related issues)
  • Fixed project file upload

1.0.11 (2017-07-20)

  • Fixing the problem where Id was used instead of IId's for Project issues
  • Fixing the naming convention for Project Issues
  • Standardized the use of parseInt in the code base
  • Removed instances of duplicate code found by code climate

1.0.10 (2017-07-13)

  • Fixing Issues #1, #2, and #3

1.0.9 (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 (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 (2017-06-23)

  • Fixing bug within the Issues API; reference to an old function.

1.0.6 (2017-06-23)

  • Fixing bug within the Labels API; Missing required argument.

1.0.5 (2017-06-23)

  • Fixing bug within the delete API calls. It was missing query parameters

1.0.4 (2017-06-23)

  • Adding more to the Labels API
  • Cleaned up the Issues class

1.0.3 (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 (2017-06-22)

  • Updating examples in ReadMe
  • Adding dependency badges
  • Removing unused test files

1.0.1 (2017-06-21)

  • Initial release
  • TODO: Tests, Examples