Skip to content

Add Browser Performance widget display condition

What does this MR do?

Provide some clarification why the Browser Performance widget is not display sometimes. Specifically with regards to the widget not displaying if the last run pipeline against the widget does not contain the performance test with the artifacts.

Related issues

https://gitlab.zendesk.com/agent/tickets/447435

This was tested on GitLab.com on a project that uses merge trains using the below gitlab-ci.yml config:

include:
  template: Verify/Browser-Performance.gitlab-ci.yml

workflow:
  rules:
    - if: $CI_PIPELINE_SOURCE == 'merge_request_event'
    - if: $CI_COMMIT_TAG
    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH

test_job:
  stage:
    build
  script:
    echo "Test Job"

browser_performance:
  stage:
    test
  variables:
    URL: https://gitlab.com
  rules:
    - if: '$CI_MERGE_REQUEST_EVENT_TYPE == "merge_train"'
      when: never
    - when: on_success

The browser performance job run successfully on the merge results pipeline and the widget displays in the merge request UI but once the merge-train pipeline runs and the job is not included the widget disappears from the MR.

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Charl Marais

Merge request reports