Add documentation for enhanced job status information in MR widget
This item updates the documentation at https://docs.gitlab.com/ee/ci/pipelines.html#seeing-job-status with the new features implemented in https://gitlab.com/gitlab-org/gitlab-ce/issues/25140.
-
Documents Feature: Show enhanced information on running deploys in MR Widget -
Follow-up from: https://gitlab.com/gitlab-org/gitlab-ce/issues/25140
New doc or update?
-
New documentation -
Update existing documentation
Checklists
Product Manager
-
Add the correct labels -
Add the correct milestone -
Indicate the correct document/directory for this feature -
Fill the doc blurb below
Documentation blurb
-
Doc title
Seeing Job Status section of Introduction to Pipelines and Jobs
-
Feature overview/description
This change improves the information available in the Merge Request widget about deployments that are ongoing. It will now show the deploying/deployed state for environments (if it's the first time we're deploying, the link will be a 404 until done.) During the deployment the stop button will be disabled, and if the pipeline fails to deploy the deployment info will be hidden.
-
Feature use cases
When a deploy has happened which put the code in an MR into an environment, we show a message in the system information box saying so. As a developer working on that MR, I'd like to see when a deploy is actively happening that will deploy the MR to an environment. Usually, while the MR is open, this is covered by the running pipeline message, where I can click through and see that a deploy is going to happen, etc. But once the MR is merged, that pipeline notice goes away. But a deploy of that MRs code may still be ongoing. e.g. when a MR merges into master and triggers a deploy to staging. When the deploy is finished, a new message will appear, but again, nothing before the deploy is finished.
We now have a similar message on build detail pages that the build will deploy, and we can do that on MR pages too.
Developer
-
Copy the doc blurb above and paste it into the doc -
Write the tutorial - explain how to use the feature -
Submit the MR using the appropriate MR description template