Skip to content

3.0.0
Compare
Choose a tag to compare
@jdalrymple jdalrymple released this 21 Mar 19:21
3.0.0
6624d64

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()
Assets 2
Loading