Commit c97bc8bb authored by Robert Hunt's avatar Robert Hunt

Added new docs section for status check widget

This section explains what the widget shows, what states the status
checks could have and common issues
parent 733027e3
......@@ -113,6 +113,32 @@ To complete the deletion of the status check you must select the
**Remove status check** button. This **permanently** deletes
the status check and it **will not** be recoverable.
## Status checks widget
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/327634) in GitLab 14.1.
![Status checks widget](img/status_checks_widget_passed_v14_0.png)
In each merge request, this widget displays the status of external status checks.
GitLab does not prevent merging of merge requests that fail these checks and they are for
informational purposes only. However, you could have a policy that disallows merging merge
requests until the status checks pass. However, GitLab can not enforce such a policy.
NOTE:
GitLab cannot guarantee that the external status checks are processed by the related external
service.
### Pending state
![Status checks widget pending](img/status_checks_widget_pending_v14_0.png)
Because GitLab cannot guarantee that external status checks are completed before viewing the
widget on a merge request, you can see a pending state.
Once GitLab [receives a response](../../../api/status_checks.md#set-approval-status-of-an-external-status-check)
from the external status check, the widget is updated accordingly.
## Troubleshooting
### Duplicate value errors
......@@ -149,6 +175,19 @@ An unexpected response was received from the branches retrieval API.
As suggested, you should close the form and reopen again or refresh the page. This error should be temporary, although
if it persists please check the [GitLab status page](https://status.gitlab.com/) to see if there is a wider outage.
### Failed to load status checks
```plaintext
Failed to load status checks
```
An unexpected response was received from the external status checks API.
You should:
- Refresh the page in case this error is temporary.
- Check the [GitLab status page](https://status.gitlab.com/) if the problem persists,
to see if there is a wider outage.
## Enable or disable status checks **(ULTIMATE SELF)**
Status checks are under development and not ready for production use. It is
......
......@@ -62,3 +62,9 @@ merge request widget takes you directly to the pages changed, making it easier a
faster to preview proposed modifications.
[Read more about Review Apps](../../../ci/review_apps/index.md).
## External status checks **(ULTIMATE)**
If you have configured [external status checks](status_checks.md) you can
see the status of these checks in merge requests
[in a specific widget](status_checks.md#status-checks-widget).
......@@ -72,8 +72,8 @@ export default {
),
errorText: s__('StatusCheck|Failed to load status checks.'),
},
docsLink: helpPagePath('user/project/merge_requests/approvals/index.md', {
anchor: 'notify-external-services',
docsLink: helpPagePath('user/project/merge_requests/status_checks.md', {
anchor: 'status-checks-widget',
}),
};
</script>
......
......@@ -9,7 +9,7 @@ exports[`Grouped test reports app when mounted matches the default state compone
<div class=\\"gl-display-flex gl-align-items-center\\">
<p class=\\"gl-line-height-normal gl-m-0\\">Status checks</p>
<!---->
</div> <span class=\\"gl-text-gray-500 gl-font-sm\\">When this merge request is updated, a call is sent to the following APIs to confirm their status. <gl-link-stub href=\\"/help/user/project/merge_requests/approvals/index.md#notify-external-services\\" class=\\"gl-font-sm\\">Learn more</gl-link-stub>.</span>
</div> <span class=\\"gl-text-gray-500 gl-font-sm\\">When this merge request is updated, a call is sent to the following APIs to confirm their status. <gl-link-stub href=\\"/help/user/project/merge_requests/status_checks.md#status-checks-widget\\" class=\\"gl-font-sm\\">Learn more</gl-link-stub>.</span>
</div>
<!---->
</div>
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment