Assign an integration epic to each component
Right now, it's not clear which epic will be used when creating issues from a component.
Add the ability to assign an integration epic where issues will be generated. This could be one per sub-type rule? Or one per component. We need to determine which would work best.
Workflow
- Take a look at this spreadsheet (internal).
- Choose some rules to look at, and add yourself their Assignee column (to avoid two or more people doing the same work).
- For each rule you've assigned to yourself, update the following columns:
- Migratable: Do we have a component or helper that we'd consider "adopted" that findings could be migrated to? Vue components in GitLab UI and ViewComponents in GitLab mean generally "Yes". Otherwise, probably "No". Sometimes it's not clear. If in doubt, ask!
-
New epic: Skip this if there's a link in Current epic. Look through existing epics, usually within gitlab-org&3107, but not necessarily. Search is your friend!
- If you find a suitable epic, add it here.
- If you cannot find a suitable epic, leave this blank, and set the Migration guide quality column to
Does not exist
.- (Optional): If you want to, create a suitable epic within gitlab-org&3107, and update things according to the steps above.
- Migration guide quality: If there is an epic, either current or new, what's the state of the migration guide?
- Notes: Put anything worth noting here, especially if you set any column to "Other...".
What's a suitable epic?
Ideally, it's an epic that has detailed migration steps that someone could follow to fix a finding in the scanner. As an example, gitlab-org&8153 is an excellent epic
for the button-class-haml-rb
rule.
An epic might just refer to a merge request that does an example migration. This is acceptable, though should be marked Needs work
in the Migration guide quality column.
Sometimes an epic doesn't exist, but a merge request or issue does. In this case, mention it in Notes, and set Migration guide quality to Does not exist
.
I'm not sure about...
No problem! Ask someone for help. If you cannot decide on the answer, note it in the spreadsheet so we know to tackle it later.
needsEpicOrWarning
linting error?
What's this From dd31bc5d:
This adds a new
needsEpicOrWarning
metadata property. Its purpose is to mark anERROR
rule as needing further investigation. This metadata is not supposed to last long. Once #52 has been closed, no rules should have this property.That further investigation should determine whether that rule should:
- get an
epic
link, with a migration guide (if we have a viable migration path for its findings), OR- be degraded to a
WARNING
, in the case that we do not have a viable migration path for its findings.