node-gitlab - npm Package Compare versions

Comparing version 1.2.1 to 1.3.0

History.md

 
+1.3.0 / 2016-08-23
+==================
+
+  * Adds support for MR notes (#20)
+  * Replace depracted package (#24)
+  * removed old test for deprecated gitlab functionality
+  * fixed project tests
+  * Fixed project member test
+  * fixed gitlab test
+  * fixed issue tests
+  * fixed hook tests
+
 1.2.1 / 2015-08-26
@@ -3,0 +15,0 @@ ==================

lib/promisify.js

@@ -18,3 +18,3 @@ /**!
 /* jshint ignore:start */
-var Promise = require('native-or-bluebird');
+var Promise = require('any-promise');
 /* jshint ignore:end */
@@ -21,0 +21,0 @@ var properties = require('./properties');

lib/properties.js

@@ -27,3 +27,9 @@ /**!
   users: [],
-  mergeRequests: [],
+  mergeRequests: [
+    'listNotes',
+    'createNote',
+    'getNote',
+    'updateNote',
+    'merge'
+  ],
   repositoryFiles: [],
@@ -48,3 +54,3 @@ repositoryBranches: [
     'getNote',
-    'updateNote',
+    'updateNote'
   ],
@@ -51,0 +57,0 @@ projects: [

lib/resources/index.js

@@ -33,6 +33,3 @@ /**!
 
-  mergeRequests: {
-    resourcePath: '/projects/:id/merge_request',
-    idName: 'merge_request_id'
-  },
+  mergeRequests: require('./merge_request'),
 
@@ -39,0 +36,0 @@ users: {

package.json

 {
   "name": "node-gitlab",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "description": "Gitlab API nodejs client.",
@@ -16,4 +16,4 @@ "main": "index.js",
   "dependencies": {
+    "any-promise": "^1.3.0",
     "debug": "~2.2.0",
-    "native-or-bluebird": "~1.2.0",
     "restful-client": "~1.0.0",
@@ -37,3 +37,5 @@ "thunkify-wrap": "~1.0.4"
   "keywords": [
-    "gitlab", "gitlab api", "git"
+    "gitlab",
+    "gitlab api",
+    "git"
   ],
@@ -40,0 +42,0 @@ "author": "fengmk2 <[e-mail]>",

README.md

@@ -829,2 +829,130 @@ gitlab
 
+---
+
+### Merge Requests
+
+https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/merge_requests.md
+
+https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/notes.md#merge-requests
+
+
+#### client.mergeRequests.list({id})
+
+Get all merge requests for the project. This function accepts pagination parameters page and per_page to return the list of merge requests.
+
+Parameters:
+
+- id (required) - The ID of a project
+- iid (optional) - Return the request having the given iid
+- state (optional) - Return all requests or just those that are merged, opened or closed
+- order_by (optional) - Return requests ordered by created_at or updated_at fields. Default is created_at
+- sort (optional) - Return requests sorted in asc or desc order. Default is desc
+
+#### client.mergeRequests.get({id, merge_request_id})
+
+Gets a single project merge request.
+
+Parameters:
+
+- id (required) - The ID of a project
+- merge_request_id (required) - The ID of MR
+
+
+#### client.mergeRequests.create({id, source_branch, target_branch, title})
+
+Creates a new merge request.
+
+Parameters:
+
+- id (required) - The ID of a project
+- source_branch (required) - The source branch
+- target_branch (required) - The target branch
+- assignee_id (optional) - Assignee user ID
+- title (required) - Title of MR
+- description (optional) - Description of MR
+- target_project_id (optional) - The target project (numeric id)
+- labels (optional) - Labels for MR as a comma-separated list
+- milestone_id (optional) - Milestone ID
+
+
+If the operation is successful, 200 and the newly created merge request is returned. If an error occurs, an error number and a message explaining the reason is returned.
+
+#### client.mergeRequests.update({id, merge_request_id})
+
+Updates an existing merge request. You can change the target branch, title, or even close the MR.
+
+Parameters:
+
+- id (required) - The ID of a project
+- merge_request_id (required) - ID of MR
+- target_branch - The target branch
+- assignee_id - Assignee user ID
+- title - Title of MR
+- description - Description of MR
+- state_event - New state (close|reopen|merge)
+- labels (optional) - Labels for MR as a comma-separated list
+- milestone_id (optional) - Milestone ID
+
+If the operation is successful, 200 and the updated merge request is returned. If an error occurs, an error number and a message explaining the reason is returned.
+
+#### client.mergeRequests.merge({id, merge_request_id})
+
+Merge changes submitted with MR using this API.
+
+Parameters:
+
+- id (required) - The ID of a project
+- merge_request_id (required) - ID of MR
+- merge_commit_message (optional) - Custom merge commit message
+- should_remove_source_branch (optional) - if true removes the source branch
+- merged_when_build_succeeds (optional) - if true the MR is merge when the build succeeds
+
+If merge success you get 200 OK.
+If it has some conflicts and can not be merged - you get 405 and error message 'Branch cannot be merged'.
+If merge request is already merged or closed - you get 405 and error message 'Method Not Allowed'
+If you don't have permissions to accept this merge request - you'll get a 401
+
+#### client.mergeRequests.listNotes({id, merge_request_id})
+
+Gets a list of all notes/comments for a single merge request.
+
+Parameters:
+
+- id (required) - The ID of a project
+- merge_request_id (required) - The ID of a project merge request
+
+
+#### client.mergeRequests.getNote({id, merge_request_id, note_id})
+
+Returns a single note for a given merge request.
+
+Parameters:
+
+- id (required) - The ID of a project
+- merge_request_id (required) - The ID of a project merge request
+- note_id (required) - The ID of a merge request note
+
+#### client.mergeRequests.createNote({id, merge_request_id})
+
+Creates a new note for a single merge request.
+
+Parameters:
+
+- id (required) - The ID of a project
+- merge_request_id (required) - The ID of a project merge request
+- body (required) - The content of a note
+
+#### client.mergeRequests.updateNote({id, merge_request_id, note_id})
+
+Modify existing note of a merge request.
+
+Parameters:
+
+- id (required) - The ID of a project
+- merge_request_id (required) - The ID of a project merge request
+- note_id (required) - The ID of a note
+- body (required) - The content of a note
+
+---
+
 ### Milestones
@@ -831,0 +959,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

54475

increased by11.53%

Number of package files

18

increased by5.88%

Lines of code

572

increased by4.76%

Number of lines in readme file

1184

increased by12.12%

Dependency changes

• + Addedany-promise@^1.3.0

• + Addedany-promise@1.3.0(transitive)

• - Removednative-or-bluebird@~1.2.0

• - Removednative-or-bluebird@1.2.0(transitive)