Add prawn, prawn-table, and prawn-svg to omnibus allowlist
What does this MR do?
Context
We want to use prawn, prawn-table, and prawn-svg to build out
PDF reporting features for our security features.
We previously built a proof of concept, and have decided to move
forward implementing the report with prawn1
Before beginning the development work, we need to:2
-
get legal approval for the gem licenses 3 -
add the license approvals to the gitlab repo (gitlab!187297 (merged)) -
add the gems to omnibus (this MR) -
add the gems to the gitlab project's Gemfile(gitlab!184931 (merged))
This MR
Add the packages to the license allowlist
Testing
- Running the
e2e:test-on-omnibus-eein the MR adding the gems, it fails. - I then pointed the branch at this omnibus branch with this change:
diff --git a/.gitlab/ci/qa-common/omnibus.gitlab-ci.yml b/.gitlab/ci/qa-common/omnibus.gitlab-ci.yml index 17eba785b9457201e6792569763fb7066dad001e..697efd2f1917794e82b91350951a84367d0349bf 100644 --- a/.gitlab/ci/qa-common/omnibus.gitlab-ci.yml +++ b/.gitlab/ci/qa-common/omnibus.gitlab-ci.yml @@ -95,7 +95,7 @@ trigger-omnibus: ee: $EE trigger: project: gitlab-org/build/omnibus-gitlab-mirror - branch: $TRIGGER_BRANCH + branch: "mbecker/tasks/add-prawn-gems-to-omnibus" strategy: depend trigger-omnibus as-if-foss: - Then, re-running the
e2e:test-on-omnibus-eejob and it passed
References
- https://gitlab.com/gitlab-com/legal-and-compliance/-/issues/2565+
- Draft: Resolve "Build proof of concept for Proj... (gitlab!183327 - closed) • Michael Becker • 17.10
- Add `prawn` and `prawn-svg` to Gemfile for PDFs (gitlab!184931 - merged) • Michael Becker • 18.0
Related issues
closes Legal review of Prawn licensing (gitlab#524059 - closed) • Michael Becker • 18.0 • On track
Checklist
See Definition of done.
For anything in this list which will not be completed, please provide a reason in the MR discussion.
Required
-
MR title and description are up to date, accurate, and descriptive. -
MR targeting the appropriate branch. -
Latest Merge Result pipeline is green. -
When ready for review, MR is labeled workflowready for review per the Distribution MR workflow.
For GitLab team members
If you don't have access to this, the reviewer should trigger these jobs for you during the review process.
-
The manual Trigger:ee-packagejobs have a green pipeline running against latest commit. -
If config/softwareorconfig/patchesdirectories are changed, make sure thebuild-package-on-all-osjob within theTrigger:ee-packagedownstream pipeline succeeded. https://gitlab.com/gitlab-org/omnibus-gitlab/-/pipelines/1767167638 -
If you are changing anything SSL related, then then/aTrigger:package:fipsmanual job within theTrigger:ee-packagedownstream pipeline must succeed. -
If CI configuration is changed, the branch must be pushed to dev.gitlab.orgto confirm regular branch builds aren't broken.
Expected (please provide an explanation if not completing)
-
Test plan indicating conditions for success has been posted and passes. -
Documentation created/updated.n/a -
Tests added.n/a -
Integration tests added to GitLab QA.n/a -
Equivalent MR/issue for the GitLab Chart opened. -
Validate potential values for new configuration settings. Formats such as integern/a10, duration10s, URIscheme://user:passwd@host:portmay require quotation or other special handling when rendered in a template and written to a configuration file.
-
These steps come from the "Getting an Unknown Licensed Software Approved" and Legal's handbook page on "Using Open Souce Software" ↩