NotificationsYou must be signed in to change notification settings
Fork673
Star2.4k

Support setting commit status#82

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

gpocentek merged 1 commit intopython-gitlab:masterfromcdbennett:commitstatus

Jan 13, 2016

Merged

Support setting commit status#82

gpocentek merged 1 commit intopython-gitlab:masterfromcdbennett:commitstatus

Jan 13, 2016

Conversation

Copy link

cdbennett commentedJan 7, 2016

Support commit status updates. Commit status can be set by a POST to
the appropriate commit URL. The status can be updated by a subsequent
POST to the same URL with the samename andref, but different
values forstate,description, etc.

gpocentek reviewed

Jan 8, 2016

View reviewed changes

gitlab/objects.py

		@@ -787,6 +802,7 @@ class Project(GitlabObject):
		managers = [
		('branches', ProjectBranchManager, [('project_id', 'id')]),
		('commits', ProjectCommitManager, [('project_id', 'id')]),
		('statuses', ProjectCommitStatusManager, [('project_id', 'id')]),

Copy link

Contributor

gpocentekJan 8, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

For consistency I'd call the attribute 'commitstatuses' instead of 'statuses' (to match the class name).

Copy link

Contributor

gpocentek commentedJan 8, 2016

Looks good, but could you address my comments? Thanks!

Copy link

Author

cdbennett commentedJan 9, 2016

Sure, thanks for the review and suggestions. I update based on your recommendations.

Support setting commit status

3371008

Support commit status updates.  Commit status can be set by a POST tothe appropriate commit URL.  The status can be updated by a subsequentPOST to the same URL with the same `name` and `ref`, but differentvalues for `state`, `description`, etc.Note: Listing the commit statuses is not yet supported.  This is donethrough a different path on the server, under the `repository` path.Example of use from the CLI:    # add a build status to a commit    gitlab project-commit-status create --project-id 2 \        --commit-id a43290c --state success --name ci/jenkins \        --target-url http://server/build/123 \        --description "Jenkins build succeeded"

cdbennett force-pushed thecommitstatus branch from7b96b0c to3371008Compare

January 12, 2016 19:09

Copy link

Author

cdbennett commentedJan 12, 2016

OK, I addressed your comments by doing the following and rebased the topic branch fresh on master:

Rename attribute to commitstatuses
Add blank line per PEP8
Remove deprecated function that was being added to Gitlab class
And also: Remove usage example from the deletedREADME.md file

The usage example seems helpful to give a quick summary of the expectations of the multiple GitLab attributes for this operation:

gitlab project-commit-status create --project-id 2 --commit-id a43290c \    --state success --name ci/jenkins --target-url http://server/build/123 \    --description "Jenkins build succeeded"

And the docstring that was in the Gitlab class function was a useful quick reference:

    This is often used for automated software build or test status.    Args:        id: Commit reference.        kwargs: Arbitrary keyword arguments for the status:            Required:            - state: pending, running, success, failed, canceled            Optional:            - description: short description of this status            - name:        label for this status e.g., name=ci/jenkins            - ref:         branch reference e.g., ref=master            - target_url:  hyperlink target for this status

At some point it would be nice to add this kind of info to the docs for the project-commit-status creation operation.