Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TRG Check Dashboard] monorepos should not throw warnings #306

Closed
hzierer opened this issue Oct 16, 2023 · 4 comments
Closed

[TRG Check Dashboard] monorepos should not throw warnings #306

hzierer opened this issue Oct 16, 2023 · 4 comments

Comments

@hzierer
Copy link

hzierer commented Oct 16, 2023

checks on repositories containing multiple components (e.g. frontend + backend) should not throw warnings regarding TRG 1.02 + TRG 2.03

TRG-Check Pipeline: https://github.com/catenax-ng/tx-traceability-foss/actions/runs/6480134583/job/17595042382#step:3:53

  1. No warnings for files which are splitted in frontend / backend:
    See: Testing Quality Guideline: TRG 1.02 - INSTALL.md
    See: Testing Quality Guideline: TRG 2.03 - Repo structure

https://github.com/catenax-ng/tx-traceability-foss/blob/main/tx-backend/INSTALL.md
https://github.com/catenax-ng/tx-traceability-foss/blob/main/frontend/INSTALL.md

  1. No failing Testing Quality Guideline: TRG 4.02 - Base images
    We are using cypress which is detected as base image and causing the base image validation step fails.
  • Detected: cypress/included:12.3.0
@Siegfriedk Siegfriedk changed the title [TRG Check] monorepos should not throw warnings [TRG Check Dashboard] monorepos should not throw warnings Oct 25, 2023
@tomaszbarwicki
Copy link
Contributor

Hi @hzierer, is this really a dashboard issue? or more general quality checks tool related? can you provide an example of a monorepo for which it is an issue?

@SebastianBezold
Copy link
Contributor

AFAIK, the warning for TRG 1.02 regarding a missing INSTALL.md is intended. This was meant to remind people, that it could be a good idea. But I also see, that it leads to confusion, especially in the monorepo case @hzierer mentioned.
I saw repos, where there have been INSTALL.md files, but in /frontend and /backend directories. In this case the reminder is odd, since they actually have the file. Just in a different place

For TRG 2.03, I only see potential issues regarding the DEPENDENCIES file name. In monorepos, we add _FRONTEND or _BACKEND suffixes. If we search for a fully matching DEPENDENCIES, this could lead to issues. The INSTALL.md issues from above could also be included in the repo structure check

@tomaszbarwicki
Copy link
Contributor

@SebastianBezold I wouldn't say the reminder is odd since the check just follows TRG description which is very clear where the INSTALL.md should be located. At the moment I see that we either amend description first and check afterwards or recommend monorepo's guys to reference other INSTALL.md files of components within original one located at root.

@Siegfriedk
Copy link
Contributor

We will get an exclusion mechanism which will make this green. We will also create a ticket to support monorepos and prioritize that accordingly

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants