Skip to content

Commit

Permalink
Moving Github Commit status stage to Use
Browse files Browse the repository at this point in the history
  • Loading branch information
christosarvanitis committed Nov 21, 2023
1 parent d946c6e commit 32c7d51
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 18 deletions.
18 changes: 0 additions & 18 deletions content/en/plugins/github-integration/install/configure.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,21 +260,3 @@ send notifications to as described in the [GitHub App accounts configuration](#g

4. Verify that the Deck UI is showing the plugin's Commit Status notification type in the notification settings for
your pipelines and the Commit Statuses are being created in GitHub.


## GitHub Commit Status pipeline stage

The GitHub Commit Status pipeline stage allows you to create a GitHub Commit Status in a repository using the GitHub App
accounts configured in the plugin without the need to configure a notification block in your pipelines and viewing the execution
status of the stage in your pipeline's execution details.

Configure the **Github Integration Commit Status Stage** as in the following screenshot:

{{< figure src="/images/plugins/github/commitStatus.png" >}}

* **GitHub Repo**: (Required) The full repository name including the GitHub Org. For example myorg/mygithubrepo.
* **Commit Ref**: (Required) The commit reference. Can be a commit SHA, branch name (heads/BRANCH_NAME), or tag name (tags/TAG_NAME).
* **Status**: (Required) The state of the status. Can be one of: error, failure, pending, success.
* **Context**: (Required) A string label to differentiate this status from the status of other systems. This field is case-insensitive.
* **Description**: (Optional) A short description of the status.

18 changes: 18 additions & 0 deletions content/en/plugins/github-integration/use.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,3 +95,21 @@ You can use the **GitHub Integration Releases Get Details** stage to fetch the l
* **Retrieve**: (Required) Select **Get Latest PreRelease**
* **Organization or User**: (Required) The organization or username that should trigger the workflow
* **Project**: (Required) Spinnaker project name

## Create GitHub Commit Status

Check warning on line 99 in content/en/plugins/github-integration/use.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/en/plugins/github-integration/use.md#L99

[Google.Headings] 'Create GitHub Commit Status' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Create GitHub Commit Status' should use sentence-style capitalization.", "location": {"path": "content/en/plugins/github-integration/use.md", "range": {"start": {"line": 99, "column": 4}}}, "severity": "WARNING"}

The GitHub Commit Status pipeline stage allows you to create a GitHub Commit Status in a repository using the GitHub App
accounts configured in the plugin without the need to configure a notification block in your pipelines and viewing the execution
status of the stage in your pipeline's execution details.

Configure the **Github Integration Commit Status Stage** as in the following screenshot:

{{< figure src="/images/plugins/github/commitStatus.png" >}}

* **GitHub Repo**: (Required) The full repository name including the GitHub Org. For example myorg/mygithubrepo.
* **Commit Ref**: (Required) The commit reference. Can be a commit SHA, branch name (heads/BRANCH_NAME), or tag name (tags/TAG_NAME).
* **Status**: (Required) The state of the status. Can be one of: error, failure, pending, success.
* **Context**: (Required) A string label to differentiate this status from the status of other systems. This field is case-insensitive.
* **Description**: (Optional) A short description of the status.


0 comments on commit 32c7d51

Please sign in to comment.