Added support for links to tech-insight checks #1203
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Changed Packages
|
|
Tests are failing - please review |
This includes UI components to render a popup menu with these links, by default on the result icon in the scorecards view. Signed-off-by: Gustaf Räntilä <g.rantila@gmail.com>
grantila
force-pushed
the
grantila/tech-insight-links
branch
from
4a164ed to
8ddba71
Compare
|
@nickboldt I forgot the api-reports, but they're there now. I think you or someone needs to approve the pipeline for this PR again. |
BethGriggs
approved these changes
Sep 17, 2024
Eswaraiahsapram
pushed a commit
to Eswaraiahsapram/community-plugins
that referenced
this pull request
Sep 17, 2024
…cks (backstage#1203) This includes UI components to render a popup menu with these links, by default on the result icon in the scorecards view. Signed-off-by: Gustaf Räntilä <g.rantila@gmail.com>
Eswaraiahsapram
added a commit
to Eswaraiahsapram/community-plugins
that referenced
this pull request
Sep 17, 2024
Signed-off-by: Eswaraiahsapram <esapram@redhat.com> fix(deps): update dependency dompurify to v3.1.3 [security] (backstage#1231) Signed-off-by: Renovate Bot <bot@renovateapp.com> Co-authored-by: backstage-goalie[bot] <97962292+backstage-goalie[bot]@users.noreply.github.com> workspace(tech-insights): added support for links to tech-insight checks (backstage#1203) This includes UI components to render a popup menu with these links, by default on the result icon in the scorecards view. Signed-off-by: Gustaf Räntilä <g.rantila@gmail.com> fix(deps): update dependency body-parser to v1.20.3 [security] (backstage#1206) Signed-off-by: Renovate Bot <bot@renovateapp.com> Co-authored-by: backstage-goalie[bot] <97962292+backstage-goalie[bot]@users.noreply.github.com> plugin(linguist): marked `createRouter`, `createRouterFromConfig`, `RouterOptions`, and `PluginOptions` as deprecated (backstage#1198) Signed-off-by: Andre Wanlin <awanlin@spotify.com> addressed review comments for argo resources timestamp Signed-off-by: Eswaraiahsapram <esapram@redhat.com>
5 tasks
Eswaraiahsapram
added a commit
to Eswaraiahsapram/community-plugins
that referenced
this pull request
Sep 19, 2024
# This is the 1st commit message: fetching resources timestamp from k8s object Signed-off-by: Eswaraiahsapram <esapram@redhat.com> fix(deps): update dependency dompurify to v3.1.3 [security] (backstage#1231) Signed-off-by: Renovate Bot <bot@renovateapp.com> Co-authored-by: backstage-goalie[bot] <97962292+backstage-goalie[bot]@users.noreply.github.com> workspace(tech-insights): added support for links to tech-insight checks (backstage#1203) This includes UI components to render a popup menu with these links, by default on the result icon in the scorecards view. Signed-off-by: Gustaf Räntilä <g.rantila@gmail.com> fix(deps): update dependency body-parser to v1.20.3 [security] (backstage#1206) Signed-off-by: Renovate Bot <bot@renovateapp.com> Co-authored-by: backstage-goalie[bot] <97962292+backstage-goalie[bot]@users.noreply.github.com> plugin(linguist): marked `createRouter`, `createRouterFromConfig`, `RouterOptions`, and `PluginOptions` as deprecated (backstage#1198) Signed-off-by: Andre Wanlin <awanlin@spotify.com> addressed review comments for argo resources timestamp Signed-off-by: Eswaraiahsapram <esapram@redhat.com> # This is the commit message backstage#2: fetched argo resources timestamp from k8s object Signed-off-by: Eswaraiahsapram <esapram@redhat.com> fetched argo resources timestamp from k8s object Signed-off-by: Eswaraiahsapram <esapram@redhat.com> fetched argo resources timestamp from k8s object Signed-off-by: Eswaraiahsapram <esapram@redhat.com>
karthikjeeyar
pushed a commit
to karthikjeeyar/community-plugins
that referenced
this pull request
Oct 28, 2024
…cks (backstage#1203) This includes UI components to render a popup menu with these links, by default on the result icon in the scorecards view. Signed-off-by: Gustaf Räntilä <g.rantila@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add links support to checks
There is currently the possibility to add
successMetadataandfailureMetadatato each check. These objects are loosely typed, and there is no standard built-in way to use them. This means, the current views won't deal with them - you have to build your own views, or possibly override the description renderer. This is fine for very custom details.I believe that links, whether a check passed or failed, are very useful. Companies likely have documentation for their checks, how to adhere to them, what they mean, etc. This is not always useful to fill in the description text, as that would bloat the UI quite a bit. Being able to click the result icon for a popup menu with links to where to read more, is very useful.
This PR adds support for this, with a new check property
links(an array of{title, url}objects). These are added in the backend, where checks are defined. Some links however, need to be constructed when the Entity object is available, to be able to read annotations, and link to external systems (Dependabot, SonarQube, etc). These links can be added by building your own function that creates a list of links per(result, entity)pair. The dynamic (entity) links will be appended to the list of static links - the popup menu will show all of them combined.When the built-in list of checks (the Scorecards) are rendered, the result icon/component will be wrapped and clickable, to show a popup menu with the links for this particular check.
Hovering the icon when it's clickable
Clicking the icon
Dynamic links
When a dynamic link is created in the UI for a specific entity, we can read the annotations and create a link to e.g. the very project of SonarQube:
✔️ Checklist
Signed-off-byline in the message. (more info)