Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@backstage-community/plugin-tech-insights

backstage15.4kApache-2.00.6.0TypeScript support: included

null

readme

Backstage Community Plugins

License CNCF Status Discord

What is the community-plugins repository?

The community-plugins repository is a place where members of the community can collaborate to develop, maintain, and share plugins. This initiative was originally driven by the need to separate plugin maintenance from the backstage/backstage core repository.

This repository is designed to provide plugin maintainers with tools and workflows to efficiently manage and publish Backstage plugins.

Contributing a plugin

Plugins created by the wider Backstage community are welcome to be published in the community-plugins repository. When you contribute a plugin to this repository, you agree to follow specific guidelines, including a standardized release process. This allows plugin owners to leverage established processes and the collective knowledge of the Backstage community-plugins community.

For those seeking full autonomy over their plugin's development and release lifecycle, self-hosting remains a supported and valid option. The decision to either contribute to the community repository or self-host will depend on whether you prefer to manage the development of the plugin independently or develop the plugin as part of a community-driven process. Both approaches are valued within the Backstage ecosystem and contribute to its growth.

Plugins that are key to the functionality and operation of Backstage will continue to reside in the backstage/backstage repository - ensuring the central components that underpin the platform are centrally managed and maintained.

To get started with creating a new plugin, follow the guidance in CONTRIBUTING.md.

Community Plugins Workflow

The community-plugins repository is formed by a set of workspaces. A workspace holds a plugin or a set of plugins based on a specific topic. For example, catalog, kubernetes, and TechDocs can be referred to as workspaces.

Each plugin belongs to a workspace and workspaces are portable enough to be moved to its own repository if desired. Each plugin workspace has its own changesets and isolated releases.

Plugins depend on other plugins via regular npm dependencies, regardless of whether the other plugins are core plugins, other plugins within the repository, or external plugins.

Although the community repository isn't technically a yarn workspace", it functions as a repository with multiple yarn workspaces, with each workspace possessing its unique .changesets directory.

Whenever a new changeset is introduced, a fresh "Version packages ($workspace_name)" PR is produced. Merging a Version packages PR will trigger the release of all the plugins in the workspaces (provided changesets have been added), and also update the CHANGELOG files.

Plugins migrated from backstage/backstage

A number of plugins that originally resided in backstage/backstage monorepo have moved to this backstage/community-plugins repository.

<summary>List of migrated plugins</summary>
  • adr
  • airbreak
  • allure
  • analytics
  • apache-airflow
  • apollo-explorer
  • azure-devops
  • azure-sites
  • badges
  • bazaar
  • bitrise
  • cicd-statistics
  • cloudbuild
  • code-climate
  • code-coverage
  • codescene
  • cost-insights
  • dynatrace
  • entity-feedback
  • entity-validation
  • example-todo-list
  • explore
  • firehydrant
  • fossa
  • gcalendar
  • gcp-projects
  • git-release-manager
  • github-actions
  • github-deployments
  • github-issues
  • github-pull-requests-board
  • gitops-profiles
  • gocd
  • graphiql
  • graphql-voyager
  • ilert
  • jenkins
  • kafka
  • lighthouse
  • microsoft-calendar
  • newrelic
  • newrelic-dashboard
  • octopus-deploy
  • opencost
  • periskop
  • playlist
  • puppetdb
  • rollbar
  • sentry
  • shortcuts
  • sonarqube
  • splunk
  • stack-overflow
  • stackstorm
  • tech-insights
  • tech-radar
  • todo
  • vault
  • xcmetrics

changelog

@backstage-community/plugin-tech-insights

0.6.0

Minor Changes

  • a01ae4e: Backstage version bump to v1.39.0

Patch Changes

0.5.2

Patch Changes

0.5.1

Patch Changes

  • 4aad9f3: remove unused devDependency canvas

0.5.0

Minor Changes

  • e919e53: Backstage version bump to v1.35.1

Patch Changes

  • f015469: Introducing a new tech insights react plugin for reusuable frontend utilities. All migrated components and APIs have been marked as deprecated. Please update your imports to come from @backstage-community/plugin-tech-insights-react

    Package json files for each plugin have been updated to reflect the new plugin in the Backstage pluginPackages metadata.

  • f015469: Several symbols have been migrated and marked deprecated. Please update all deprecated symbols to import from @backstage-community/plugin-tech-insights-react instead.

  • Updated dependencies [f015469]
  • Updated dependencies [e919e53]
  • Updated dependencies [c107e0f]

0.4.0

Minor Changes

  • 5abfb11: Backstage version bump to v1.34.2

Patch Changes

0.3.42

Patch Changes

0.3.41

Patch Changes

  • 9a09c39: Remove use of react 18 useId hook to maintain compatibility with react 17.

0.3.40

Patch Changes

0.3.39

Patch Changes

0.3.38

Patch Changes

  • caa9401: ScorecardInfo description now supports markdown syntax

0.3.37

Patch Changes

0.3.36

Patch Changes

  • 42a2c31: Export component extensions instead of routable extensions when routes aren't required (or used). ResultCheckIcon can now wrap both React components and HTML elements for onClick handling of the popup menu with links.

0.3.35

Patch Changes

  • 1d33996: Added support for links for checks. Static links are defined in the backend for each check. Dynamic links (based on the entity, e.g. to go to github repos, sonarqube projects, etc) are defined with functions in the frontend, when registering the tech-insights API. Two new components are added, TechInsightsCheckIcon and TechInsightsLinksMenu. The former to wrap a result icon with a popup menu with links, the second is the component to show the popup with links (which can be arbitrarily componsed in other UI views).
  • Updated dependencies [1d33996]

0.3.34

Patch Changes

0.3.33

Patch Changes

0.3.32

Patch Changes

  • 83a5e80: Refactor ScorecardInfo to accordion to display categories and fail counts.

0.3.31

Patch Changes

  • 0265767: Update to latest backstage versions.

0.3.30

Patch Changes

  • 7ac338c: Update Backstage to 1.29.1 Remove usage of deprecated API endpoints except tokenManager
  • 794cc8b: Fix api reports generated with the wrong name Update @backstage/cli to 0.26.11 Add missing Backstage fields in package.json
  • a8d8d44: Enable CSV export in scorecard page table.
  • Updated dependencies [794cc8b]

0.3.29

Patch Changes

0.3.28

Patch Changes

  • d4a8be1: Provide an overview page about checks for entities.

0.3.27

Patch Changes

0.3.26

Patch Changes

0.3.26-next.1

Patch Changes

0.3.26-next.0

Patch Changes

0.3.25

Patch Changes

0.3.24

Patch Changes

0.3.23

Patch Changes

0.3.23-next.2

Patch Changes

0.3.23-next.1

Patch Changes

0.3.23-next.0

Patch Changes

0.3.22

Patch Changes

0.3.22-next.3

Patch Changes

0.3.22-next.2

Patch Changes

0.3.22-next.1

Patch Changes

0.3.22-next.0

Patch Changes

0.3.21

Patch Changes

0.3.21-next.2

Patch Changes

0.3.21-next.1

Patch Changes

0.3.21-next.0

Patch Changes

0.3.20

Patch Changes

0.3.20-next.3

Patch Changes

0.3.20-next.2

Patch Changes

0.3.20-next.1

Patch Changes

0.3.20-next.0

Patch Changes

0.3.18

Patch Changes

0.3.18-next.2

Patch Changes

0.3.18-next.1

Patch Changes

0.3.18-next.0

Patch Changes

0.3.17

Patch Changes

0.3.17-next.2

Patch Changes

0.3.17-next.1

Patch Changes

0.3.17-next.0

Patch Changes

0.3.16

Patch Changes

0.3.16-next.3

Patch Changes

0.3.16-next.2

Patch Changes

0.3.16-next.1

Patch Changes

0.3.15-next.0

Patch Changes

0.3.13

Patch Changes

0.3.13-next.2

Patch Changes

0.3.13-next.1

Patch Changes

0.3.13-next.0

Patch Changes

0.3.12

Patch Changes

0.3.12-next.2

Patch Changes

0.3.12-next.1

Patch Changes

0.3.12-next.0

Patch Changes

0.3.11

Patch Changes

0.3.11-next.3

Patch Changes

0.3.11-next.2

Patch Changes

0.3.11-next.1

Patch Changes

0.3.11-next.0

Patch Changes

0.3.10

Patch Changes

0.3.10-next.2

Patch Changes

0.3.10-next.1

Patch Changes

  • 22963209d23: Added the possibility to customize the check description in the scorecard component.

    • The CheckResultRenderer type now exposes an optional description method that allows to overwrite the description with a different string or a React component for a provided check result.

    Until now only the BooleanCheck element could be overridden, but from now on it's also possible to override the description for a check. As an example, the description could change depending on the check result. Refer to the README file for more details

  • Updated dependencies

0.3.10-next.0

Patch Changes

0.3.9

Patch Changes

0.3.9-next.3

Patch Changes

0.3.9-next.2

Patch Changes

0.3.9-next.1

Patch Changes

0.3.9-next.0

Patch Changes

0.3.8

Patch Changes

0.3.8-next.2

Patch Changes

0.3.8-next.1

Patch Changes

0.3.8-next.0

Patch Changes

0.3.7

Patch Changes

0.3.7-next.2

Patch Changes

0.3.7-next.1

Patch Changes

0.3.7-next.0

Patch Changes

0.3.6

Patch Changes

0.3.6-next.2

Patch Changes

0.3.6-next.1

Patch Changes

0.3.6-next.0

Patch Changes

0.3.5

Patch Changes

0.3.4

Patch Changes

0.3.4-next.4

Patch Changes

0.3.4-next.3

Patch Changes

0.3.4-next.2

Patch Changes

0.3.4-next.1

Patch Changes

0.3.4-next.0

Patch Changes

0.3.3

Patch Changes

0.3.3-next.1

Patch Changes

0.3.2-next.0

Patch Changes

0.3.1

Patch Changes

0.3.1-next.2

Patch Changes

0.3.1-next.1

Patch Changes

0.3.1-next.0

Patch Changes

0.3.0

Minor Changes

  • f7e99ac1d8: Added the possibility to display check results of different types on a single scorecard.

    • BREAKING Removed the getScorecardsDefinition method from the TechInsightsApi interface. Added the getCheckResultRenderers method that returns rendering components for given types.
    • BREAKING The CheckResultRenderer type now exposes the component factory method that creates a React component used to display a result of a provided check result.
    • The TechInsightsClient constructor accepts now the optional renderers parameter that can be used to inject a custom renderer.
    • BREAKING The title parameter in the EntityTechInsightsScorecardContent and EntityTechInsightsScorecardCard components is now mandatory.
    • The jsonRulesEngineCheckResultRenderer used to render json-rules-engine check results is exported.
    • The BooleanCheck component that can be used to render other check results types is also exported.

    If you were overriding the getScorecardsDefinition method to adjust the rendering of check results, you should now provide a custom renderer using renderers parameter in the TechInsightsClient class.

    See the README for more details.

Patch Changes

0.3.0-next.3

Patch Changes

0.3.0-next.2

Patch Changes

0.3.0-next.1

Minor Changes

  • f7e99ac1d8: Added the possibility to display check results of different types on a single scorecard.

    • BREAKING Removed the getScorecardsDefinition method from the TechInsightsApi interface. Added the getCheckResultRenderers method that returns rendering components for given types.
    • BREAKING The CheckResultRenderer type now exposes the component factory method that creates a React component used to display a result of a provided check result.
    • The TechInsightsClient constructor accepts now the optional renderers parameter that can be used to inject a custom renderer.
    • BREAKING The title parameter in the EntityTechInsightsScorecardContent and EntityTechInsightsScorecardCard components is now mandatory.
    • The jsonRulesEngineCheckResultRenderer used to render json-rules-engine check results is exported.
    • The BooleanCheck component that can be used to render other check results types is also exported.

    If you were overriding the getScorecardsDefinition method to adjust the rendering of check results, you should now provide a custom renderer using renderers parameter in the TechInsightsClient class.

    See the README for more details.

Patch Changes

0.2.5-next.0

Patch Changes

0.2.4

Patch Changes

0.2.4-next.1

Patch Changes

0.2.4-next.0

Patch Changes

0.2.3

Patch Changes

0.2.3-next.3

Patch Changes

0.2.3-next.2

Patch Changes

0.2.3-next.1

Patch Changes

0.2.3-next.0

Patch Changes

0.2.2

Patch Changes

0.2.2-next.1

Patch Changes

0.2.2-next.0

Patch Changes

0.2.1

Patch Changes

0.2.1-next.2

Patch Changes

0.2.1-next.1

Patch Changes

0.2.1-next.0

Patch Changes

0.2.0

Minor Changes

  • 567b13a84a: Add checksId option to EntityTechInsightsScorecardContent component

Patch Changes

0.2.0-next.1

Minor Changes

  • 567b13a84a: Add checksId option to EntityTechInsightsScorecardContent component

Patch Changes

0.1.14-next.0

Patch Changes

0.1.13

Patch Changes

0.1.12

Patch Changes

0.1.12-next.0

Patch Changes

0.1.11

Patch Changes

0.1.10

Patch Changes

0.1.9

Patch Changes

0.1.8

Patch Changes

0.1.8-next.0

Patch Changes

0.1.7

Patch Changes

0.1.7-next.0

Patch Changes

0.1.6

Patch Changes

0.1.6-next.0

Patch Changes

0.1.5

Patch Changes

0.1.4

Patch Changes

0.1.3

Patch Changes

0.1.2

Patch Changes

0.1.1

Patch Changes

0.1.0

Minor Changes

  • b5bd60fddc: New package containing UI components for the Tech Insights plugin.

Patch Changes