Skip to content

Latest commit

 

History

History
104 lines (86 loc) · 4.17 KB

README.md

File metadata and controls

104 lines (86 loc) · 4.17 KB
Raw

GoCD build status notifier Build Status

This is GoCD's Notification plugin that updates SCM with build status.

Supported:

  • GitHub Pull request status junk

Requirements

These plugins require GoCD version >= v15.x or above.

Get Started

Installation:

  • Download the latest plugin jar from Releases section. Place it in <go-server-location>/plugins/external & restart Go Server.

Behavior

  • Go Server notifies the plugin on every Stage Status Change with relevant details. The plugin scans the build-cause to see if the github.pr / stash.pr / gerrit.cs material is present.
  • If it is, then Pull Request/Change Set status is updated with status=stage-result, context=pipeline-name/stage-name & target-url=trackback-url.

Configuration

  • You will see Github Pull Requests status notifier / Stash Pull Requests status notifier / Gerrit Change Set status notifier on plugin listing page ![Plugins listing page][1]

  • You can configure the plugin (this feature requires GoCD version >= v15.2, use system properties to configure the plugin). The details should be as follows:

    • Server Base URL The URL of your go-server (by default, http://localhost:8153).
    • End Point If using enterprise edition, this needs to be configured for the enterprise endpoint. Else, it can be left blank.
    • Username A Github user with push access to the repository.
    • Password If not using two factor authentication, this is the password for the given Github user. Else, it can be left blank.
    • OAuth Token If using two-factor authentication, provide a personal access toke instead of the password above. Else, it can be left blank.

![Configure plugin pop-up][2]

  • When the stage status changes... ![Pipeline Schedule][3]

  • The PR state is updated! ![Update Status][4]

Target URL:

  • You can provide trackback through system property go.plugin.build.status.go-server. It defaults to 'http://localhost:8153' if not available. Eg:
-Dgo.plugin.build.status.go-server=http://localhost:8153

GitHub

Authentication:

  • You can choose to provide username & password through system property go.plugin.build.status.github.username & go.plugin.build.status.github.password. Eg:
-Dgo.plugin.build.status.github.username=johndoe
-Dgo.plugin.build.status.github.password=thisaintapassword

or provide the oauth access token through system property go.plugin.build.status.github.oauth.

-Dgo.plugin.build.status.github.username=johndoe
-Dgo.plugin.build.status.github.oauth=thisaintatoken
  • (or) through file ~/.github on Go Server with the following contents:
login=johndoe
password=thisaintapassword

or

login=johndoe
oauth=thisaintatoken

Github Enterprise:

  • You can choose to provide endpoint through system property go.plugin.build.status.github.endpoint. Eg:
-Dgo.plugin.build.status.github.endpoint=http://code.yourcompany.com
  • (or) through file ~/.github on Go Server with the following contents:
endpoint=http://code.yourcompany.com

Stash

Setup:

  • You need to provide endpoint, username & password through system property go.plugin.build.status.stash.endpoint, go.plugin.build.status.stash.username & go.plugin.build.status.stash.password. Eg:
-Dgo.plugin.build.status.stash.endpoint=http://localhost:7990
-Dgo.plugin.build.status.stash.username=johndoe
-Dgo.plugin.build.status.stash.password=thisaintapassword

Gerrit

Setup:

  • You need to provide endpoint, username, password & codeReviewLabel through system property go.plugin.build.status.gerrit.endpoint, go.plugin.build.status.gerrit.username, go.plugin.build.status.gerrit.password, go.plugin.build.status.gerrit.codeReviewLabel. Eg:
-Dgo.plugin.build.status.gerrit.endpoint=http://localhost:7990
-Dgo.plugin.build.status.gerrit.username=johndoe
-Dgo.plugin.build.status.gerrit.password=thisaintapassword
-Dgo.plugin.build.status.gerrit.codeReviewLabel=Verified

FAQs