Backstage Community Plugins

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.

@backstage-community/plugin-tech-insights-common

0.7.1

Patch Changes

• ba5bf7b: Fix runBulkCheck logic to run when no entities are found

0.7.0

Minor Changes

• d6411fe: run bulk checks in chunks (a 750)
• a01ae4e: Backstage version bump to v1.39.0

0.6.0

Minor Changes

• ac739ca: Adds permissions for use by the tech-insights apis.

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.

• c107e0f: Deprecates TechInsightCheck from the tech-insights-node library in favor of Check coming from the tech-insights-common library.

  With this change comes a refactor of Check from a type to an interface.

  The TechInsightCheck interface will be removed from the tech-insights-node plugin in it's next major release.

  Importing Check from @backstage-community/plugin-tech-insights-common/client has been deprecated in favor of importing directly from @backstage-community/plugin-tech-insights-common.

0.4.0

Minor Changes

• 5abfb11: Backstage version bump to v1.34.2

0.3.0

Minor Changes

• 5289c38: Add metadata to TechInsightCheck

0.2.21

Patch Changes

• 331daba: Cache identical API calls for a few seconds. This prevents fetching the same checks multiple times when having several Scorecards with the same (or all) checks, although with different filters.

0.2.20

Patch Changes

• 7a14237: Backstage version bump to v1.32.2

0.2.19

Patch Changes

• e516773: Remove usages of deprecated references and usage of @backstage/backend-common
• e516773: Backstage version bump to v1.31.1

0.2.18

Patch Changes

• 1d33996: Added links property for checks, to allow the UI to render links for users to click and get more information about individual checks, what they mean, how to adhere to them, etc.

0.2.17

Patch Changes

• a84eb44: Move client to common package and allow to use backend auth system

0.2.16

Patch Changes

• 00d148d: Backstage version bump to v1.30.2

0.2.15

Patch Changes

• 794cc8b: Fix api reports generated with the wrong name Update @backstage/cli to 0.26.11 Add missing Backstage fields in package.json

0.2.14

Patch Changes

• cbad35a: Updated dependencies.

0.2.13

Patch Changes

• 193a2a3: Migrated from the backstage/backstage monorepo.

0.2.12

Patch Changes

• 406b786a2a2c: Mark package as being free of side effects, allowing more optimized Webpack builds.
• Updated dependencies
  • @backstage/types@1.1.1

0.2.12-next.0

Patch Changes

• 406b786a2a2c: Mark package as being free of side effects, allowing more optimized Webpack builds.
• Updated dependencies
  • @backstage/types@1.1.1-next.0

0.2.11

Patch Changes

• Updated dependencies
  • @backstage/types@1.1.0

0.2.10

Patch Changes

• 4024b37449: TechInsightsApi interface now has getFactSchemas() method. TechInsightsClient now implements method getFactSchemas().

  BREAKING FactSchema type moved from @backstage-community/plugin-tech-insights-node into @backstage-community/plugin-tech-insights-common

  These changes are required if you were importing this type directly.

  - import { FactSchema } from '@backstage-community/plugin-tech-insights-node';
  + import { FactSchema } from '@backstage-community/plugin-tech-insights-common';

• Updated dependencies

  • @backstage/types@1.0.2

0.2.10-next.0

Patch Changes

• 4024b37449: TechInsightsApi interface now has getFactSchemas() method. TechInsightsClient now implements method getFactSchemas().

  BREAKING FactSchema type moved from @backstage-community/plugin-tech-insights-node into @backstage-community/plugin-tech-insights-common

  These changes are required if you were importing this type directly.

  - import { FactSchema } from '@backstage-community/plugin-tech-insights-node';
  + import { FactSchema } from '@backstage-community/plugin-tech-insights-common';

• Updated dependencies

  • @backstage/types@1.0.2

0.2.9

Patch Changes

• Updated dependencies
  • @backstage/types@1.0.2

0.2.9-next.1

Patch Changes

• Updated dependencies
  • @backstage/types@1.0.2-next.1

0.2.9-next.0

Patch Changes

• Updated dependencies
  • @backstage/types@1.0.2-next.0

0.2.8

Patch Changes

• Updated dependencies
  • @backstage/types@1.0.1

0.2.8-next.0

Patch Changes

• Updated dependencies
  • @backstage/types@1.0.1-next.0

0.2.7

Patch Changes

• Updated dependencies
  • @backstage/types@1.0.0

0.2.7-next.2

Patch Changes

• Updated dependencies
  • @backstage/types@1.0.0

0.2.7-next.1

Patch Changes

• Updated dependencies
  • @backstage/types@1.0.0

0.2.7-next.0

Patch Changes

• Updated dependencies
  • @backstage/types@1.0.0

0.2.6

Patch Changes

• 29f782eb37: Updated dependency @types/luxon to ^3.0.0.

0.2.6-next.0

Patch Changes

• 29f782eb37: Updated dependency @types/luxon to ^3.0.0.

0.2.5

Patch Changes

• 4e9a90e307: Updated dependency luxon to ^3.0.0.

0.2.5-next.0

Patch Changes

• 4e9a90e307: Updated dependency luxon to ^3.0.0.

0.2.4

Patch Changes

• Updated dependencies
  • @backstage/types@1.0.0

0.2.3

Patch Changes

• Fix for the previous release with missing type declarations.
• Updated dependencies
  • @backstage/types@0.1.3

0.2.2

Patch Changes

• c77c5c7eb6: Added backstage.role to package.json
• Updated dependencies
  • @backstage/types@0.1.2

0.2.1

Patch Changes

• a60eb0f0dd: adding new operation to run checks for multiple entities in one request

0.2.0

Minor Changes

• b5bd60fddc: Added new property 'result' in CheckResult in @backstage-community/plugin-tech-insights-common. This property is later used in @backstage-community/plugin-tech-insights package.