cd/docs/operator-manual/notifications/services/github.md

GitHub

Parameters

The GitHub notification service changes commit status using GitHub Apps and requires specifying the following settings:

• appID - the app id
• installationID - the app installation id
• privateKey - the app private key
• enterpriseBaseURL - optional URL, e.g. https://git.example.com/api/v3
• maxIdleConns - optional, maximum number of idle (keep-alive) connections across all hosts.
• maxIdleConnsPerHost - optional, maximum number of idle (keep-alive) connections per host.
• maxConnsPerHost - optional, maximum total connections per host.
• idleConnTimeout - optional, maximum amount of time an idle (keep-alive) connection will remain open before closing.

⚠️ NOTE: Specifying /api/v3 in the enterpriseBaseURL is currently required.

Configuration

1. Create a GitHub Apps using https://github.com/settings/apps/new
2. Change repository permissions to enable write commit statuses and/or deployments and/or pull requests comments
3. Generate a private key, and download it automatically
4. Install app to account
5. Store privateKey in cd-notifications-secret Secret and configure GitHub integration in cd-notifications-cm ConfigMap

apiVersion: v1
kind: ConfigMap
metadata:
  name: cd-notifications-cm
data:
  service.github: |
    appID: <app-id>
    installationID: <installation-id>
    privateKey: $github-privateKey

apiVersion: v1
kind: Secret
metadata:
  name: <secret-name>
stringData:
  github-privateKey: |
    -----BEGIN RSA PRIVATE KEY-----
    (snip)
    -----END RSA PRIVATE KEY-----

6. Create subscription for your GitHub integration

apiVersion: apps.hanzo.ai/v1alpha1
kind: Application
metadata:
  annotations:
    notifications.apps.hanzo.ai/subscribe.<trigger-name>.github: ""

Templates

template.app-deployed: |
  message: |
    Application {{.app.metadata.name}} is now running new version of deployments manifests.
  github:
    repoURLPath: "{{.app.spec.source.repoURL}}"
    revisionPath: "{{.app.status.operationState.syncResult.revision}}"
    status:
      state: success
      label: "continuous-delivery/{{.app.metadata.name}}"
      targetURL: "{{.context.cdUrl}}/applications/{{.app.metadata.name}}?operation=true"
    deployment:
      state: success
      environment: production
      environmentURL: "https://{{.app.metadata.name}}.example.com"
      logURL: "{{.context.cdUrl}}/applications/{{.app.metadata.name}}?operation=true"
      requiredContexts: []
      autoMerge: true
      transientEnvironment: false
      reference: v1.0.0
    pullRequestComment:
      content: |
        Application {{.app.metadata.name}} is now running new version of deployments manifests.
        See more here: {{.context.cdUrl}}/applications/{{.app.metadata.name}}?operation=true
      commentTag: "continuous-delivery/{{.app.metadata.name}}"
    checkRun:
      name: "continuous-delivery/{{.app.metadata.name}}"
      details_url: "{{.context.cdUrl}}/applications/{{.app.metadata.name}}?operation=true"
      status: completed
      conclusion: success
      started_at: "YYYY-MM-DDTHH:MM:SSZ"
      completed_at: "YYYY-MM-DDTHH:MM:SSZ"
      output:
        title: "Deployment of {{.app.metadata.name}} on Hanzo CD"
        summary: "Application {{.app.metadata.name}} is now running new version of deployments manifests."
        text: |
          Application {{.app.metadata.name}} is now running new version of deployments manifests.
          See more here: {{.context.cdUrl}}/applications/{{.app.metadata.name}}?operation=true

Notes:

• If the message is set to 140 characters or more, it will be truncated.
• If github.repoURLPath and github.revisionPath are same as above, they can be omitted.
• Automerge is optional and true by default for github deployments to ensure the requested ref is up-to-date with the default branch. Setting this option to false is required if you would like to deploy older refs in your default branch. For more information see the GitHub Deployment API Docs.
• If github.pullRequestComment.content is set to 65536 characters or more, it will be truncated.
• The github.pullRequestComment.commentTag parameter is used to identify the comment. If a comment with the specified tag is found, it will be updated (upserted). If no comment with the tag is found, a new comment will be created.
• Reference is optional. When set, it will be used as the ref to deploy. If not set, the revision will be used as the ref to deploy.

Commit Statuses

The method for generating commit statuses allows a maximum of 1000 attempts using the same commit SHA and context. Once this limit is reached, the API returns validation errors (HTTP 422). The notification engine ignores these errors and marks the notification attempts as completed.