tanuki v0.2.0 Tanuki.Projects.Repository.Commits

Interact with the commits on a project

Summary

Functions

GET /projects/:id/repository/commits/:sha/comments

POST /projects/:id/repository/commits/:sha/comments

POST /projects/:id/statuses/:sha

GET /projects/:id/repository/commits/:sha/diff

GET /projects/:id/repository/commits/:sha

GET /projects/:id/repository/commits

GET /projects/:id/repository/commits/:sha/statuses

Functions

comments(id, sha, client)

GET /projects/:id/repository/commits/:sha/comments

Get the comments of a commit in a project.

create_comment(id, sha, client)

POST /projects/:id/repository/commits/:sha/comments

Adds a comment to a commit. Optionally you can post comments on a specific line of a commit. Therefor both path, line_new and line_old are required.

Parameters:

  • note (required) - Text of comment
  • path (optional) - The file path
  • line (optional) - The line number
  • line_type (optional) - The line type (new or old)
create_status(id, sha, client, params)

POST /projects/:id/statuses/:sha

Adds or updates a status of a commit.

Parameters:

  • state (required) - The state of the status. Can be: pending, running, success, failed, canceled
  • ref (optional) - The ref (branch or tag) to which the status refers
  • name or context (optional) - The label to differentiate this status from the status of other systems. Default: “default”
  • target_url (optional) - The target URL to associate with this status
  • description (optional) - The short description of the status
diff(id, sha, client)

GET /projects/:id/repository/commits/:sha/diff

Get the diff of a commit in a project.

find(id, sha, client)

GET /projects/:id/repository/commits/:sha

Get a specific commit identified by the commit hash or name of a branch or tag.

list(id, client, params \\ [])

GET /projects/:id/repository/commits

Get a list of repository commits in a project.

Parameters:

  • ref_name (optional) - The name of a repository branch or tag or if not given the default branch
status(id, sha, client, params \\ [])

GET /projects/:id/repository/commits/:sha/statuses

Get the statuses of a commit in a project.

Parameters:

  • ref (optional) - Filter by ref name, it can be branch or tag
  • stage (optional) - Filter by stage
  • name (optional) - Filer by status name, eg. jenkins
  • all (optional) - The flag to return all statuses, not only latest ones