Releases: jdalrymple/gitbeaker
Releases · jdalrymple/gitbeaker
3.0.0
Summary
- Exporting all services seperatly ie. const { Projects } from 'node-gitlab-api'; as well as the usual default export: const Gitlab from 'node-gitlab-api'
- 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] 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 -> Enviroments
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.6
Summary
- Fixed more issues within the url concatenation
2.2.4
Summary
- Fixed the missing options for tags.all #40
- Added delete key method to UserKeys.js #41 thanks to Claude Abounegm
2.2.3
Summary
- Custom Attributes has been fixed for users, groups, and projects
2.2.2
Summary
- Minor bug fix for the version support
2.2.1
Summary
- Added Version API support
2.2.0
Summary
- 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 Enviroments API and the Project Jobs API thanks to Jeff Pelton in PR #28
- Fixing parse function to handle encoded urls that dont 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
Summary
- 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 itsprojects.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 toall
- The
update
functions are no longer supported and have all been renamed toedit
- The
addKey
function has been renamed toadd
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.0-rc.2
- 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 toall
for consistency - Renamed
update
functions toedit
for consistency - Renaming addKey just to add in UserKeys class
- Renaming deploy_keys and merge_requests to deployKeys and mergeRequests for consistancy
- 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
To use this version, Run npm install --save package@next to install prerelease package
1.3.2
- Adding default values for the BaseModel's helper functions