Backstage

English | 한국어 | 中文版 | Français

What is Backstage?

Backstage is an open source framework for building developer portals. Powered by a centralized software catalog, Backstage restores order to your microservices and infrastructure and enables your product teams to ship high-quality code quickly without compromising autonomy.

Backstage unifies all your infrastructure tooling, services, and documentation to create a streamlined development environment from end to end.

Out of the box, Backstage includes:

• Backstage Software Catalog for managing all your software such as microservices, libraries, data pipelines, websites, and ML models
• Backstage Software Templates for quickly spinning up new projects and standardizing your tooling with your organization’s best practices
• Backstage TechDocs for making it easy to create, maintain, find, and use technical documentation, using a "docs like code" approach
• Plus, a growing ecosystem of open source plugins that further expand Backstage’s customizability and functionality

Backstage was created by Spotify but is now hosted by the Cloud Native Computing Foundation (CNCF) as an Incubation level project. For more information, see the announcement.

Project roadmap

For information about the detailed project roadmap including delivered milestones, see the Roadmap.

Getting Started

To start using Backstage, see the Getting Started documentation.

Documentation

The documentation of Backstage includes:

• Main documentation
• Software Catalog
• Architecture (Decisions)
• Designing for Backstage
• Storybook - UI components

Community

To engage with our community, you can use the following resources:

• Discord chatroom - Get support or discuss the project
• Contributing to Backstage - Start here if you want to contribute
• RFCs - Help shape the technical direction
• FAQ - Frequently Asked Questions
• Code of Conduct - This is how we roll
• Adopters - Companies already using Backstage
• Blog - Announcements and updates
• Newsletter - Subscribe to our email newsletter
• Backstage Community Sessions - Join monthly meetups and explore Backstage community
• Give us a star ⭐️ - If you are using Backstage or think it is an interesting project, we would love a star ❤️

Governance

See the GOVERNANCE.md document in the backstage/community repository.

License

Copyright 2020-2025 © The Backstage Authors. All rights reserved. The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our Trademark Usage page: https://www.linuxfoundation.org/trademark-usage

Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0

Security

Please report sensitive security issues using Spotify's bug-bounty program rather than GitHub.

For further details, see our complete security release process.

@backstage/plugin-scaffolder-common

1.5.10

Patch Changes

• 09cf038: Got rid of most @backstage/backend-common usages
• 321b93e: Add optional lifecycle property to the spec field of Template entities.
• Updated dependencies
  • @backstage/catalog-model@1.7.3
  • @backstage/types@1.2.1
  • @backstage/plugin-permission-common@0.8.4

1.5.10-next.0

Patch Changes

• 09cf038: Got rid of most @backstage/backend-common usages
• Updated dependencies
  • @backstage/catalog-model@1.7.3
  • @backstage/types@1.2.1
  • @backstage/plugin-permission-common@0.8.4

1.5.9

Patch Changes

• Updated dependencies
  • @backstage/types@1.2.1
  • @backstage/catalog-model@1.7.3
  • @backstage/plugin-permission-common@0.8.4

1.5.9-next.0

Patch Changes

• Updated dependencies
  • @backstage/types@1.2.1-next.0
  • @backstage/catalog-model@1.7.3-next.0
  • @backstage/plugin-permission-common@0.8.4-next.0

1.5.8

Patch Changes

• 3c62a50: Experimental support for formDecorators to enable secret collection and mutations to the parameters for scaffolder tasks
• Updated dependencies
  • @backstage/catalog-model@1.7.2
  • @backstage/types@1.2.0
  • @backstage/plugin-permission-common@0.8.3

1.5.8-next.1

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@1.7.2-next.0
  • @backstage/types@1.2.0
  • @backstage/plugin-permission-common@0.8.3-next.0

1.5.8-next.0

Patch Changes

• 3c62a50: Experimental support for formDecorators to enable secret collection and mutations to the parameters for scaffolder tasks
• Updated dependencies
  • @backstage/catalog-model@1.7.1
  • @backstage/types@1.2.0
  • @backstage/plugin-permission-common@0.8.2

1.5.7

Patch Changes

• f61d4cc: Add scaffolder permission scaffolder.template.management for accessing the template management features
• Updated dependencies
  • @backstage/types@1.2.0
  • @backstage/plugin-permission-common@0.8.2
  • @backstage/catalog-model@1.7.1

1.5.7-next.0

Patch Changes

• f61d4cc: Add scaffolder permission scaffolder.template.management for accessing the template management features
• Updated dependencies
  • @backstage/catalog-model@1.7.0
  • @backstage/types@1.1.1
  • @backstage/plugin-permission-common@0.8.1

1.5.6

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@1.7.0
  • @backstage/types@1.1.1
  • @backstage/plugin-permission-common@0.8.1

1.5.5

Patch Changes

• Updated dependencies
  • @backstage/plugin-permission-common@0.8.1
  • @backstage/catalog-model@1.6.0
  • @backstage/types@1.1.1

1.5.5-next.2

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@1.6.0-next.0
  • @backstage/types@1.1.1
  • @backstage/plugin-permission-common@0.8.1-next.1

1.5.5-next.1

Patch Changes

• Updated dependencies
  • @backstage/plugin-permission-common@0.8.1-next.1
  • @backstage/catalog-model@1.5.0
  • @backstage/types@1.1.1

1.5.5-next.0

Patch Changes

• Updated dependencies
  • @backstage/plugin-permission-common@0.8.1-next.0
  • @backstage/catalog-model@1.5.0
  • @backstage/types@1.1.1

1.5.4

Patch Changes

• Updated dependencies
  • @backstage/plugin-permission-common@0.8.0
  • @backstage/catalog-model@1.5.0
  • @backstage/types@1.1.1

1.5.3

Patch Changes

• d44a20a: Added additional plugin metadata to package.json.

• bcec60f: added the following new permissions to the scaffolder backend endpoints:

  • scaffolder.task.create
  • scaffolder.task.cancel
  • scaffolder.task.read

• Updated dependencies

  • @backstage/plugin-permission-common@0.7.14
  • @backstage/catalog-model@1.5.0
  • @backstage/types@1.1.1

1.5.3-next.1

Patch Changes

• d44a20a: Added additional plugin metadata to package.json.
• Updated dependencies
  • @backstage/plugin-permission-common@0.7.14-next.0
  • @backstage/catalog-model@1.5.0
  • @backstage/types@1.1.1

1.5.3-next.0

Patch Changes

• bcec60f: added the following new permissions to the scaffolder backend endpoints:

  • scaffolder.task.create
  • scaffolder.task.cancel
  • scaffolder.task.read

1.5.2

Patch Changes

• 9156654: Capturing more event clicks for scaffolder
• Updated dependencies
  • @backstage/catalog-model@1.5.0

1.5.2-next.1

Patch Changes

• 9156654: Capturing more event clicks for scaffolder

1.5.2-next.0

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@1.5.0-next.0
  • @backstage/types@1.1.1
  • @backstage/plugin-permission-common@0.7.13

1.5.1

Patch Changes

• Updated dependencies
  • @backstage/plugin-permission-common@0.7.13
  • @backstage/catalog-model@1.4.5
  • @backstage/types@1.1.1

1.5.1-next.1

Patch Changes

• Updated dependencies
  • @backstage/plugin-permission-common@0.7.13-next.1
  • @backstage/catalog-model@1.4.5-next.0
  • @backstage/types@1.1.1

1.5.1-next.0

Patch Changes

• Updated dependencies
  • @backstage/plugin-permission-common@0.7.13-next.0
  • @backstage/catalog-model@1.4.5-next.0
  • @backstage/types@1.1.1

1.5.0

Minor Changes

• 11b9a08: Introduced the first version of recoverable tasks.

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@1.4.4
  • @backstage/types@1.1.1
  • @backstage/plugin-permission-common@0.7.12

1.5.0-next.1

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@1.4.4-next.0
  • @backstage/types@1.1.1
  • @backstage/plugin-permission-common@0.7.12

1.5.0-next.0

Minor Changes

• 11b9a08: Introduced the first version of recoverable tasks.

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@1.4.3
  • @backstage/types@1.1.1
  • @backstage/plugin-permission-common@0.7.12

1.4.5

Patch Changes

• 178b8d8: Updated Template.v1beta3.schema.json, added a missing "presentation" field
• Updated dependencies
  • @backstage/plugin-permission-common@0.7.12
  • @backstage/catalog-model@1.4.3
  • @backstage/types@1.1.1

1.4.4

Patch Changes

• Updated dependencies
  • @backstage/plugin-permission-common@0.7.11
  • @backstage/catalog-model@1.4.3
  • @backstage/types@1.1.1

1.4.3

Patch Changes

• 2e0cef42ab: Add missing required property type in Template.v1beta3.schema.json schema
• 76d07da66a: Make it possible to define control buttons text (Back, Create, Review) per template
• Updated dependencies
  • @backstage/plugin-permission-common@0.7.10
  • @backstage/catalog-model@1.4.3
  • @backstage/types@1.1.1

1.4.3-next.1

Patch Changes

• 76d07da66a: Make it possible to define control buttons text (Back, Create, Review) per template
• Updated dependencies
  • @backstage/catalog-model@1.4.3
  • @backstage/types@1.1.1
  • @backstage/plugin-permission-common@0.7.9

1.4.3-next.0

Patch Changes

• 2e0cef42ab: Add missing required property type in Template.v1beta3.schema.json schema
• Updated dependencies
  • @backstage/catalog-model@1.4.3
  • @backstage/types@1.1.1
  • @backstage/plugin-permission-common@0.7.9

1.4.2

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@1.4.3
  • @backstage/types@1.1.1
  • @backstage/plugin-permission-common@0.7.9

1.4.2-next.0

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@1.4.3-next.0
  • @backstage/types@1.1.1
  • @backstage/plugin-permission-common@0.7.9-next.0

1.4.1

Patch Changes

• 406b786a2a2c: Mark package as being free of side effects, allowing more optimized Webpack builds.
• Updated dependencies
  • @backstage/catalog-model@1.4.2
  • @backstage/plugin-permission-common@0.7.8
  • @backstage/types@1.1.1

1.4.1-next.2

Patch Changes

• 406b786a2a2c: Mark package as being free of side effects, allowing more optimized Webpack builds.
• Updated dependencies
  • @backstage/catalog-model@1.4.2-next.2
  • @backstage/plugin-permission-common@0.7.8-next.2
  • @backstage/types@1.1.1-next.0

1.4.1-next.1

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@1.4.2-next.1
  • @backstage/plugin-permission-common@0.7.8-next.1
  • @backstage/types@1.1.0

1.4.1-next.0

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@1.4.2-next.0
  • @backstage/plugin-permission-common@0.7.8-next.0
  • @backstage/types@1.1.0

1.4.0

Minor Changes

• e514aac3eac0: Introduce each property on action steps, allowing them to be ran repeatedly.

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@1.4.1
  • @backstage/types@1.1.0
  • @backstage/plugin-permission-common@0.7.7

1.3.2

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@1.4.1
  • @backstage/types@1.1.0
  • @backstage/plugin-permission-common@0.7.7

1.3.2-next.0

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@1.4.1-next.0
  • @backstage/types@1.1.0
  • @backstage/plugin-permission-common@0.7.7-next.0

1.3.1

Patch Changes

• Updated dependencies
  • @backstage/types@1.1.0
  • @backstage/catalog-model@1.4.0
  • @backstage/plugin-permission-common@0.7.6

1.3.1-next.1

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@1.4.0-next.1
  • @backstage/types@1.0.2
  • @backstage/plugin-permission-common@0.7.6-next.0

1.3.1-next.0

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@1.4.0-next.0
  • @backstage/plugin-permission-common@0.7.6-next.0
  • @backstage/types@1.0.2

1.3.0

Minor Changes

• 82e10a6939c: Add support for Markdown text blob outputs from templates

• 67115f532b8: Expose scaffolder permissions in new sub-aggregations.

  In addition to exporting a list of all scaffolder permissions in scaffolderPermissions, scaffolder-common now exports scaffolderTemplatePermissions and scaffolderActionPermissions, which contain subsets of the scaffolder permissions separated by resource type.

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@1.3.0
  • @backstage/types@1.0.2
  • @backstage/plugin-permission-common@0.7.5

1.3.0-next.0

Minor Changes

• 82e10a6939c: Add support for Markdown text blob outputs from templates

1.2.7

Patch Changes

• 65e989f4018: Added permissions for authorizing parameters and steps
• 48da4c46e45: Export typeguard for isTemplateEntityV1beta3
• bcae5aaf25c: Added permissions for authorizing actions
• 65e989f4018: Define optional backstage:permissions property to parameters and steps used to authorize part of the template using the permission framework
• Updated dependencies
  • @backstage/plugin-permission-common@0.7.5
  • @backstage/catalog-model@1.3.0
  • @backstage/types@1.0.2

1.2.7-next.2

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@1.3.0-next.0
  • @backstage/types@1.0.2
  • @backstage/plugin-permission-common@0.7.5-next.0

1.2.7-next.1

Patch Changes

• 65e989f4018: Added permissions for authorizing parameters and steps
• 65e989f4018: Define optional backstage:permissions property to parameters and steps used to authorize part of the template using the permission framework
• Updated dependencies
  • @backstage/plugin-permission-common@0.7.5-next.0
  • @backstage/catalog-model@1.2.1
  • @backstage/types@1.0.2

1.2.7-next.0

Patch Changes

• 48da4c46e45: Export typeguard for isTemplateEntityV1beta3
• Updated dependencies
  • @backstage/catalog-model@1.2.1
  • @backstage/types@1.0.2

1.2.6

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@1.2.1
  • @backstage/types@1.0.2

1.2.6-next.1

Patch Changes

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

1.2.6-next.0

Patch Changes

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

1.2.5

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@1.2.0
  • @backstage/types@1.0.2

1.2.5-next.1

Patch Changes

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

1.2.5-next.0

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@1.1.6-next.0

1.2.4

Patch Changes

• 011bd518b7: Fixed spelling mistakes in documentation.
• Updated dependencies
  • @backstage/catalog-model@1.1.5
  • @backstage/types@1.0.2

1.2.4-next.1

Patch Changes

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

1.2.4-next.0

Patch Changes

• 011bd518b7: Fixed spelling mistakes in documentation.
• Updated dependencies
  • @backstage/catalog-model@1.1.5-next.0
  • @backstage/types@1.0.2

1.2.3

Patch Changes

• Updated dependencies
  • @backstage/types@1.0.2
  • @backstage/catalog-model@1.1.4

1.2.3-next.1

Patch Changes

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

1.2.3-next.0

Patch Changes

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

1.2.2

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@1.1.3
  • @backstage/types@1.0.1

1.2.2-next.0

Patch Changes

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

1.2.1

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@1.1.2
  • @backstage/types@1.0.0

1.2.1-next.2

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@1.1.2-next.2
  • @backstage/types@1.0.0

1.2.1-next.1

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@1.1.2-next.1
  • @backstage/types@1.0.0

1.2.1-next.0

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@1.1.2-next.0
  • @backstage/types@1.0.0

1.2.0

Minor Changes

• 1ff817b3f0: add entity metadata to the template info type

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@1.1.1

1.2.0-next.1

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@1.1.1-next.0

1.2.0-next.0

Minor Changes

• 1ff817b3f0: add entity metadata to the template info type

1.1.2

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@1.1.0

1.1.2-next.0

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@1.1.0-next.0

1.1.1

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@1.0.3

1.1.1-next.0

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@1.0.3-next.0

1.1.0

Minor Changes

• f8baf7df44: Added the ability to reference the user in the template.yaml manifest

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@1.0.2

1.1.0-next.0

Minor Changes

• f8baf7df44: Added the ability to reference the user in the template.yaml manifest

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@1.0.2-next.0

1.0.1

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@1.0.1

1.0.1-next.0

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@1.0.1-next.0

1.0.0

Major Changes

• b58c70c223: This package has been promoted to v1.0! To understand how this change affects the package, please check out our versioning policy.

Patch Changes

• c8475ab3bb: Adding some documentation for exported things
• Updated dependencies
  • @backstage/catalog-model@1.0.0
  • @backstage/types@1.0.0

0.3.0

Minor Changes

• 310e905998: The following deprecations are now breaking and have been removed:

  • BREAKING: Support for backstage.io/v1beta2 Software Templates has been removed. Please migrate your legacy templates to the new scaffolder.backstage.io/v1beta3 apiVersion by following the migration guide

  • BREAKING: Removed the deprecated TemplateMetadata. Please use TemplateInfo instead.

  • BREAKING: Removed the deprecated context.baseUrl. It's now available on context.templateInfo.baseUrl.

  • BREAKING: Removed the deprecated DispatchResult, use TaskBrokerDispatchResult instead.

  • BREAKING: Removed the deprecated runCommand, use executeShellCommond instead.

  • BREAKING: Removed the deprecated Status in favour of TaskStatus instead.

  • BREAKING: Removed the deprecated TaskState in favour of CurrentClaimedTask instead.

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@0.13.0

0.3.0-next.0

Minor Changes

• 310e905998: The following deprecations are now breaking and have been removed:

  • BREAKING: Support for backstage.io/v1beta2 Software Templates has been removed. Please migrate your legacy templates to the new scaffolder.backstage.io/v1beta3 apiVersion by following the migration guide

  • BREAKING: Removed the deprecated TemplateMetadata. Please use TemplateInfo instead.

  • BREAKING: Removed the deprecated context.baseUrl. It's now available on context.templateInfo.baseUrl.

  • BREAKING: Removed the deprecated DispatchResult, use TaskBrokerDispatchResult instead.

  • BREAKING: Removed the deprecated runCommand, use executeShellCommond instead.

  • BREAKING: Removed the deprecated Status in favour of TaskStatus instead.

  • BREAKING: Removed the deprecated TaskState in favour of CurrentClaimedTask instead.

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@0.13.0-next.0

0.2.3

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@0.12.0

0.2.2

Patch Changes

• a4d53fe18e: DEPRECATED - The TaskSpec.metadata and TaskSpec.baseUrl has been deprecated in favour of the new TaskSpec.templateInfo. The baseUrl is now found on the templateInfo object, and the name can be inferred from the templateInfo.entityRef property.

  Usages of TaskSpec.metadata.name or ctx.metadata.name in Actions should migrate to using parseEntityRef(taskSpec.templateInfo.entityRef) to get the parsed entity triplet.

  Usages of ctx.baseUrl in Actions should migrate to using ctx.templateInfo.baseUrl instead.

• Updated dependencies

  • @backstage/catalog-model@0.11.0

0.2.1

Patch Changes

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

0.2.0

Minor Changes

• 5e585bbc7f: BREAKING: Removed the templateEntityV1beta3Schema export

Patch Changes

• e72d371296: Added TemplateEntityV1beta2 which was moved here from @backstage/plugin-scaffolder-common. It has also been marked as deprecated in the process - please consider migrating to v1beta3 templates.
• c77c5c7eb6: Added backstage.role to package.json
• Updated dependencies
  • @backstage/catalog-model@0.10.0
  • @backstage/types@0.1.2

0.1.3

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@0.9.10

0.1.3-next.0

Patch Changes

• Updated dependencies
  • @backstage/catalog-model@0.9.10-next.0

0.1.2

Patch Changes

• d078377f67: Support navigating back to pre-filled templates to update inputs of scaffolder tasks for resubmission

0.1.1

Patch Changes

• 10615525f3: Switch to use the json and observable types from @backstage/types
• Updated dependencies
  • @backstage/catalog-model@0.9.6