Add sidebar component for standards adherence list page
What does this MR do and why?
What
Adds the sidebar component to the standards adherence list page
Why
Allows users to expand and view fix suggestions for their standards adherence checks
Screenshots or screen recordings
Screenshots are required for UI changes, and strongly recommended for all other merge requests.
Sidebar Closed | Sidebar Open |
---|---|
![]() |
![]() |
How to set up and validate locally
Enable FFs
- In the rails console (
rails c
) enable the following features: -
adherence_report_ui
(Feature.enable(:adherence_report_ui)
) -
compliance_adherence_report
(Feature.enable(:compliance_adherence_report)
)
Setup Adherences
- Visit group settings and enable "Prevent approval by author" from the 'Merge Request Approval' section.
- This will create a couple of rows inside the
project_compliance_standards_adherence
table.
Visit Standard Adherence page
- Visit a group, under Secure (new UI) or Security & Compliance (old UI) > Compliance center
- Click
View details
to expand the sidebar component
MR acceptance checklist
This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.
-
I have evaluated the MR acceptance checklist for this MR.
Merge request reports
Activity
changed milestone to %16.3
assigned to @jmontal
- Resolved by 🤖 GitLab Bot 🤖
Proper labels assigned to this merge request. Please ignore me.
@jmontal - please see the following guidance and update this merge request.1 Error Please add typebug typefeature, or typemaintenance label to this merge request. Edited by 🤖 GitLab Bot 🤖
- A deleted user
added featureaddition frontend typefeature labels
24 Warnings This merge request is quite big (622 lines changed), please consider splitting it into multiple merge requests. 335863a9: Commits that change 30 or more lines across at least 3 files should describe these changes in the commit body. For more information, take a look at our Commit message guidelines. 2b9e67c9: Commits that change 30 or more lines across at least 3 files should describe these changes in the commit body. For more information, take a look at our Commit message guidelines. fe0ae339: Commits that change 30 or more lines across at least 3 files should describe these changes in the commit body. For more information, take a look at our Commit message guidelines. 5131f9ab: Commits that change 30 or more lines across at least 3 files should describe these changes in the commit body. For more information, take a look at our Commit message guidelines. 390ac1ba: The commit subject may not be longer than 72 characters. For more information, take a look at our Commit message guidelines. d3301eae: The commit subject may not be longer than 72 characters. For more information, take a look at our Commit message guidelines. 2f649010: Commits that change 30 or more lines across at least 3 files should describe these changes in the commit body. For more information, take a look at our Commit message guidelines. ad443a58: The commit body should not contain more than 72 characters per line. For more information, take a look at our Commit message guidelines. 8857873c: The commit subject must start with a capital letter. For more information, take a look at our Commit message guidelines. 671fa747: Commits that change 30 or more lines across at least 3 files should describe these changes in the commit body. For more information, take a look at our Commit message guidelines. 4d9dacc5: The commit body should not contain more than 72 characters per line. For more information, take a look at our Commit message guidelines. f6b88a0f: The commit body should not contain more than 72 characters per line. For more information, take a look at our Commit message guidelines. d045d24c: The commit body should not contain more than 72 characters per line. For more information, take a look at our Commit message guidelines. d2399973: Commits that change 30 or more lines across at least 3 files should describe these changes in the commit body. For more information, take a look at our Commit message guidelines. e637c5ec: Commits that change 30 or more lines across at least 3 files should describe these changes in the commit body. For more information, take a look at our Commit message guidelines. 5aebfcd4: Commits that change 30 or more lines across at least 3 files should describe these changes in the commit body. For more information, take a look at our Commit message guidelines. bf52b0d1: The commit body should not contain more than 72 characters per line. For more information, take a look at our Commit message guidelines. 73ca4452: The commit body should not contain more than 72 characters per line. For more information, take a look at our Commit message guidelines. b2f6385f: The commit subject must contain at least 3 words. For more information, take a look at our Commit message guidelines. 9c173d40: Commits that change 30 or more lines across at least 3 files should describe these changes in the commit body. For more information, take a look at our Commit message guidelines. This merge request has more than 20 commits which may cause issues in some of the jobs. If you see errors like missing commits, please consider squashing some commits so it is within 20 commits. featureaddition and featureenhancement merge requests normally have a documentation change. Consider adding a documentation update or confirming the documentation plan with the Technical Writer counterpart.
For more information, see:
- The Handbook page on merge request types.
- The definition of done documentation.
This merge request contains lines with testid selectors. Please ensure e2e:package-and-test
job is run.Testid Selectors
The following changed lines in this MR contain testid selectors:
- file
ee/app/assets/javascripts/compliance_dashboard/components/standards_adherence_report/fix_suggestions_sidebar.vue
: -
-
<h2 class="gl-mt-0" data-testid="sidebar-title">{{ adherenceCheckName }}</h2>
-
-
-
<h4 data-testid="sidebar-requirement-title" class="gl-mt-0">
-
-
-
<span data-testid="sidebar-requirement-content">{{ adherenceCheckDescription }}</span>
-
-
-
<h4 data-testid="sidebar-failure-title" class="gl-mt-0">
-
-
-
<span data-testid="sidebar-failure-content">{{ adherenceCheckFailureReason }}</span>
-
-
-
<div data-testid="sidebar-how-to-fix">
-
-
-
data-testid="sidebar-mr-settings-button"
-
-
-
data-testid="sidebar-mr-settings-learn-more-button"
-
If the
e2e:package-and-test
job in theqa
stage has run automatically, please ensure the tests are passing. If the job has not run, please start thetrigger-omnibus-and-follow-up-e2e
job in theqa
stage and ensure the tests infollow-up-e2e:package-and-test-ee
pipeline are passing.For the list of known failures please refer to the latest pipeline triage issue.
If your changes are under a feature flag, please check our Testing with feature flags documentation for instructions.
Reviewer roulette
Changes that require review have been detected!
Please refer to the table below for assigning reviewers and maintainers suggested by Danger in the specified category:
Category Reviewer Maintainer frontend Doug Stull (
@dstull
) (UTC-4, 2 hours ahead of@jmontal
)Simon Knox (
@psimyn
) (UTC+10, 16 hours ahead of@jmontal
)UX Annabel Dunstone Gray (
@annabeldunstone
) (UTC+0, 6 hours ahead of@jmontal
)Maintainer review is optional for UX Please check reviewer's status!
Feel free to override these selections if you think someone else would be better-suited or use the GitLab Review Workload Dashboard to find other available reviewers.
To read more on how to use the reviewer roulette, please take a look at the Engineering workflow and code review guidelines. Please consider assigning a reviewer or maintainer who is a domain expert in the area of the merge request.
Once you've decided who will review this merge request, assign them as a reviewer! Danger does not automatically notify them for you.
If needed, you can retry the
danger-review
job that generated this comment.Generated by
DangerAllure report
allure-report-publisher
generated test report!e2e-test-on-gdk:
test report for 2d89222bexpand test summary
+------------------------------------------------------------------+ | suites summary | +-------------+--------+--------+---------+-------+-------+--------+ | | passed | failed | skipped | flaky | total | result | +-------------+--------+--------+---------+-------+-------+--------+ | Create | 38 | 0 | 0 | 0 | 38 | ✅ | | Govern | 36 | 0 | 0 | 0 | 36 | ✅ | | Manage | 12 | 0 | 1 | 0 | 13 | ✅ | | Data Stores | 20 | 0 | 0 | 1 | 20 | ❗ | | Plan | 51 | 0 | 0 | 0 | 51 | ✅ | | Verify | 8 | 0 | 0 | 0 | 8 | ✅ | +-------------+--------+--------+---------+-------+-------+--------+ | Total | 165 | 0 | 1 | 1 | 166 | ❗ | +-------------+--------+--------+---------+-------+-------+--------+
e2e-review-qa:
test report for 2d89222bexpand test summary
+-----------------------------------------------------------------------+ | suites summary | +------------------+--------+--------+---------+-------+-------+--------+ | | passed | failed | skipped | flaky | total | result | +------------------+--------+--------+---------+-------+-------+--------+ | Create | 8 | 0 | 1 | 2 | 9 | ❗ | | Package | 0 | 0 | 1 | 0 | 1 | ➖ | | Govern | 35 | 0 | 0 | 0 | 35 | ✅ | | Manage | 1 | 0 | 0 | 0 | 1 | ✅ | | Framework sanity | 0 | 0 | 1 | 0 | 1 | ➖ | | Monitor | 4 | 0 | 0 | 0 | 4 | ✅ | | Plan | 3 | 0 | 1 | 0 | 4 | ✅ | | Data Stores | 2 | 0 | 0 | 0 | 2 | ✅ | +------------------+--------+--------+---------+-------+-------+--------+ | Total | 53 | 0 | 4 | 2 | 57 | ❗ | +------------------+--------+--------+---------+-------+-------+--------+
added 657 commits
-
648c3352...5f2bf1e0 - 653 commits from branch
master
- 5a316173 - Create list for standards adherence report
- 96209a48 - Use GraphQL endpoint
- cdc717ae - Updates based on maintainer feedback
- f239f157 - Add standards adherence report sidebar
Toggle commit list-
648c3352...5f2bf1e0 - 653 commits from branch
Bundle size analysis [beta]
This compares changes in bundle size for entry points between the commits c4644439 and 2d89222b
Special assetsEntrypoint / Name Size before Size after Diff Diff in percent average 4.22 MB 4.22 MB - 0.0 % mainChunk 3.1 MB 3.1 MB - 0.0 %
Note: We do not have exact data for c4644439. So we have used data from: 96ebac3b.
The intended commit has no webpack pipeline, so we chose the last commit with one before it.Please look at the full report for more details
Read more about how this report works.
Generated by
DangerSetting label groupcompliance based on
@jmontal
's group.added groupcompliance label
Setting label(s) devopsgovern sectionsec based on groupcompliance.
added devopsgovern sectionsec labels
added 838 commits
-
b212b7b1...cd8384ea - 834 commits from branch
master
- e7b8f283 - Create list for standards adherence report
- b9694f3d - Use GraphQL endpoint
- c1d4ac27 - Updates based on maintainer feedback
- 7d7ca843 - Add standards adherence report sidebar
Toggle commit list-
b212b7b1...cd8384ea - 834 commits from branch
@jmontal Some end-to-end (E2E) tests should run based on the stage label.
Please start the
trigger-omnibus-and-follow-up-e2e
job in theqa
stage and ensure tests in thefollow-up-e2e:package-and-test-ee
pipeline pass before this MR is merged. (E2E tests are computationally intensive and don't run automatically for every push/rebase, so we ask you to run this job manually at least once.)To run all E2E tests, apply the pipeline:run-all-e2e label and run a new pipeline.
E2E test jobs are allowed to fail due to flakiness. See current failures at the latest pipeline triage issue.
Once done, apply the
emoji on this comment.For any questions or help, reach out on the internal #quality Slack channel.
- Resolved by Phil Hughes
Would you have the capacity to do the initial frontend review? (If not I can assign to another review)
Thanks!
added workflowin review label
requested review from @lorenzvanherwaarden
mentioned in issue gitlab-org/govern/compliance/general#138
removed review request for @lorenzvanherwaarden
- Resolved by Lorenz van Herwaarden
- Resolved by Lorenz van Herwaarden
- Resolved by Lorenz van Herwaarden
- Resolved by Lorenz van Herwaarden
- Resolved by Lorenz van Herwaarden
- Resolved by Lorenz van Herwaarden
- Resolved by Lorenz van Herwaarden
- Resolved by Lorenz van Herwaarden
- Resolved by Jay Montal
- Resolved by Jay Montal
- Resolved by Lorenz van Herwaarden
- Resolved by Lorenz van Herwaarden
- Resolved by Lorenz van Herwaarden
- Resolved by Lorenz van Herwaarden
- Resolved by Lorenz van Herwaarden
- Resolved by Lorenz van Herwaarden
- Resolved by Lorenz van Herwaarden
- Resolved by Lorenz van Herwaarden
- Resolved by Lorenz van Herwaarden
- Resolved by Jay Montal
- Resolved by Lorenz van Herwaarden
requested review from @lorenzvanherwaarden
removed review request for @lorenzvanherwaarden
changed milestone to %16.4
added missed:16.3 label
mentioned in issue gitlab-org/govern/compliance/general#136
requested review from @lorenzvanherwaarden
- Resolved by Lorenz van Herwaarden
- Resolved by Lorenz van Herwaarden
- Resolved by Lorenz van Herwaarden
- Resolved by Lorenz van Herwaarden
- Resolved by Lorenz van Herwaarden
- Resolved by Lorenz van Herwaarden
- Resolved by Lorenz van Herwaarden
added Technical Writing UX labels
- Resolved by Libor Vanc
requested review from @cam.x
Hi @eread - could you please do the Technical Writing review for this please?
There's a few threads above that aren't resolved so I will also mention you in those for clarity, thanks!
requested review from @eread
- Resolved by Jay Montal
added UI text label
removed review request for @eread
- Resolved by Jay Montal
- Resolved by Jay Montal
@lorenzvanherwaarden
, thanks for approving this merge request.This is the first time the merge request has been approved. To ensure full test coverage, a new pipeline will be started shortly.
For more info, please refer to the following links:
added pipeline:mr-approved label
removed review request for @lorenzvanherwaarden
requested review from @lvanc
removed review request for @cam.x
added 1 commit
- 271f5aac - Updates based on docs feedback and final initial feedback
added 1 commit
- fe0ae339 - Updates based on docs feedback and final initial feedback
- Resolved by Jay Montal
@jmontal Overall it works as expected, just noticed a few things.
suggestion(non-blocking): after reviewing the drawer, it looks like the large heading in the drawer title is causing the close button to appear lower since everything is middle aligning inside the title container.
What do you think about either...
- moving status (e.g. "Fail etestr") outside of the title container like in the storybook example
- Making the text title smaller / removing the
h2
-
top
aligning the content in the title
Current (middle aligned) Expected (Top aligned) @gitlab-com/gitlab-ux/ux-foundations any thoughts on this
added 4100 commits
-
fe0ae339...3dc7cc59 - 4094 commits from branch
master
- 0392d94a - Create list for standards adherence report
- 39d3dbbd - Use GraphQL endpoint
- 395bca5b - Updates based on maintainer feedback
- d80a744d - Add standards adherence report sidebar
- 2b9e67c9 - Updates based on initial feedback
- 335863a9 - Updates based on docs feedback and final initial feedback
Toggle commit list-
fe0ae339...3dc7cc59 - 4094 commits from branch
- Resolved by Phil Hughes
requested review from @iamphill
- Resolved by Phil Hughes
- Resolved by Phil Hughes
- Resolved by Jay Montal
removed review request for @iamphill
added 7 commits
- e7b8f283 - Create list for standards adherence report
- b9694f3d - Use GraphQL endpoint
- c1d4ac27 - Updates based on maintainer feedback
- 10307088 - Add standards adherence report sidebar
- 5131f9ab - Updates based on initial feedback
- fe0ae339 - Updates based on docs feedback and final initial feedback
- 7c9a0b8b - Merge branch '413718_adherence_report_sidebar' of gitlab.com:gitlab-org/gitlab...
Toggle commit listrequested review from @iamphill
mentioned in issue #419961 (closed)
marked the checklist item I have evaluated the MR acceptance checklist for this MR. as completed
- Resolved by Phil Hughes
- Resolved by Phil Hughes
removed review request for @iamphill
- Resolved by Jay Montal
added 1 commit
- 7f160a70 - Merge branch '413718_adherence_report_sidebar' of gitlab.com:gitlab-org/gitlab...
mentioned in issue #413718 (closed)
mentioned in issue #421327 (closed)
removed review request for @lvanc
added 1 commit
- a060b2be - Merge branch '413718_adherence_report_sidebar' of gitlab.com:gitlab-org/gitlab...
added 1 commit
- 2d89222b - Merge branch '413718_adherence_report_sidebar' of gitlab.com:gitlab-org/gitlab...
requested review from @iamphill
mentioned in merge request !131280 (merged)
mentioned in merge request gitlab-org/gitlab-services/design.gitlab.com!3536 (merged)
enabled an automatic merge when the pipeline for 6351e6fe succeeds
mentioned in commit 087d10da
added workflowstaging-canary label and removed workflowin review label
added workflowcanary label and removed workflowstaging-canary label
added workflowstaging label and removed workflowcanary label
added workflowproduction label and removed workflowstaging label
added workflowpost-deploy-db-staging label and removed workflowproduction label
added workflowpost-deploy-db-production label and removed workflowpost-deploy-db-staging label
added releasedcandidate label
added releasedpublished label and removed releasedcandidate label
mentioned in merge request kubitus-project/kubitus-installer!2437 (merged)