Skip to content

Commit

Permalink
docs: updating release notes across all packages to support service d…
Browse files Browse the repository at this point in the history
…ependency sync

Signed-off-by: Tiago Barbosa <[email protected]>
  • Loading branch information
t1agob committed Jul 26, 2024
1 parent 562cbc4 commit e6031b0
Show file tree
Hide file tree
Showing 5 changed files with 91 additions and 4 deletions.
26 changes: 26 additions & 0 deletions docs/release-notes/backend.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,31 @@
# Release notes for Backend plugin

## > 0.9.0

[GitHub release](https://github.com/PagerDuty/backstage-plugin-backend/releases/tag/0.9.0)

### Summary

This release introduces a set of features that were in a way dependent on each other which makes it quite large when compared to a typical release.

- **Automated Backstage integration setup for mapped entities**: With the goal of simplifying the setup process for mapped entities we introduced a feature that automatically creates a integration on the corresponding PagerDuty service when a `pagerduty.com/service-id` property is available.

With this feature, admins can skip the step of creating an integration in PagerDuty and copy the integration key to each Backstage entity file. They can now simply add the `pagerduty.com/service-id` annotation to their service, or simply use the `PagerDutyPage` to map existing PagerDuty services to Backstage entities and the plugin will take care of the rest.

- **Plugin configuration persistence layer**: To support two-way sync for service dependencies we decided to give the admins the option of choosing which is their main source of truth and for that reason we introduced a new section in `PagerDutyPage` where you can specify your preferences. The backend centralises all the persistence layer and this release includes all the necessary methods for it.

- **Two-way service dependency sync**: This release introduces a way to keep your service dependencies in sync between PagerDuty and Backstage. Admins will be able to choose which source is the main one. This is an opt-in feature that you can enable on the `PagerDutyPage` under the `configuration` tab.

‼️ **Important**: Due to a Backstage design decision it is not possible to fully overwrite the relations specified in each entity's configuration file. For that reason the option to synchronise strictly from PagerDuty side is not available.

### Changes

- feat: service dependency sync

### Dependencies

- `@pagerduty/backstage-plugin-common: 0.2.1`

## > 0.8.2

[GitHub release](https://github.com/PagerDuty/backstage-plugin-backend/releases/tag/0.8.2)
Expand Down
12 changes: 12 additions & 0 deletions docs/release-notes/common.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# Release notes for Common library

## > 0.2.1

[GitHub release](https://github.com/PagerDuty/backstage-plugin-common/releases/tag/0.2.1)

### Summary

This PR adds support for a new settings type to support the service dependency sync feature.

### Changes

- feat: service dependency sync

## > 0.2.0

[GitHub release](https://github.com/PagerDuty/backstage-plugin-common/releases/tag/0.2.0)
Expand Down
22 changes: 22 additions & 0 deletions docs/release-notes/entity-processor.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,27 @@
# Release notes for Entity Processor module

## > 0.3.0

[GitHub release](https://github.com/PagerDuty/backstage-plugin-entity-processor/releases/tag/0.3.0)

### Summary

This release introduces support for service dependency syncing and automatically creating Backstage integrations in PagerDuty for all new mappings.

With these changes, we are reducing the manual effort on configuring integration keys and service dependencies into Backstage configuration files and ensuring they stay in-sync with PagerDuty.

‼️ **Important**: Due to a Backstage design decision it is not possible to fully overwrite the relations specified in each entity's configuration file. For that reason the option to synchronise strictly from PagerDuty side is not available.

### Changes

- refactor: removing PagerDuty sync to limitation in Backstage
- chore: updating backstage plugin config
- feat: service dependency sync

### Dependencies

- `@pagerduty/backstage-plugin-common: 0.2.1`

## > 0.2.1

[GitHub release](https://github.com/PagerDuty/backstage-plugin-entity-processor/releases/tag/0.2.1)
Expand Down
33 changes: 30 additions & 3 deletions docs/release-notes/frontend.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,32 @@
# Release notes for Frontend plugin

## > 0.15.0

[GitHub release](https://github.com/PagerDuty/backstage-plugin/releases/tag/0.15.0)

### Summary

This release updates the `PagerDutyPage` component to add a new configurations tab where users can configure how they want to sync service dependencies between Backstage and PagerDuty.

<img width="811" alt="image" src="https://github.com/user-attachments/assets/f8332378-2439-4b7d-b130-b73acccd666b">

**By default, service dependency syncing is disabled.** It's an opt-in feature and admins need to be aware of what it does because you might end up deleting existing service dependencies on Backstage or PagerDuty.

‼️ Important: Due to a Backstage design decision it is not possible to fully overwrite the relations specified in each entity's configuration file. For that reason the option to synchronise strictly from PagerDuty side is not available.

On this release we also introduced a fix that was preventing users from showing/hiding columns on the service to entity mapping table.

### Changes

- refactor: disabled PagerDuty option due to a design limitation on Backstage
- fix: turned columnvisibility into a static object
- feat: service dependency sync

### Dependencies

- `@pagerduty/backstage-plugin-backend: 0.9.0`
- `@pagerduty/backstage-plugin-common: 0.2.1`

## > 0.14.1

[GitHub release](https://github.com/PagerDuty/backstage-plugin/releases/tag/0.14.1)
Expand All @@ -13,7 +40,7 @@ It also bumps Backstage package versions and fixes a high severity security issu
### Changes

- chore(deps): bump fast-loops from 1.1.3 to 1.1.4
chore: remove json parse from unsafe code
- chore: remove json parse from unsafe code

### Dependencies

Expand Down Expand Up @@ -132,7 +159,7 @@ We decided to use this opportunity to upgrade all packages (_see list of upgrade

### Summary

This release introduces a new UI component - `PagerDutySmallCard` - which allows users to still have visibility on the status of their PagerDuty services in Backstage without using so much screen space. This new UI component removes information on *incidents* and *recent changes*, and moves *insights* and *on call* information to collapsable panels that can optionally be removed.
This release introduces a new UI component - `PagerDutySmallCard` - which allows users to still have visibility on the status of their PagerDuty services in Backstage without using so much screen space. This new UI component removes information on _incidents_ and _recent changes_, and moves _insights_ and _on call_ information to collapsable panels that can optionally be removed.

![small-card](../images/small-card-collapsed.png)

Expand Down Expand Up @@ -328,7 +355,7 @@ With this changes instead of getting an out-of-context error message users will

Version 0.8.2 bumps the version of `@pagerduty/backstage-plugin-common` to version 0.0.2.

Version 0.0.1 had a misconfiguration that was forcing the backend plugin to load it as an *ES6 module* and while that's supported for the frontend it is not yet fully supported for backend plugins.
Version 0.0.1 had a misconfiguration that was forcing the backend plugin to load it as an _ES6 module_ and while that's supported for the frontend it is not yet fully supported for backend plugins.

This dependency upgrade syncs the version of the common package between frontend and backend plugins.

Expand Down
2 changes: 1 addition & 1 deletion overrides/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{% block announce %}
<div>
<p>
<strong>🎉 New release!</strong> <span style="margin-left: 20px;"> Checkout the latest versions for Frontend(<a href="/backstage-plugin-docs/release-notes/frontend/#0141">0.14.1</a>), Backend(<a href="/backstage-plugin-docs/release-notes/backend/#082">0.8.2</a>), Common(<a href="/backstage-plugin-docs/release-notes/common/#020">0.2.0</a>), Scaffolder Actions(<a href="/backstage-plugin-docs/release-notes/scaffolder-actions/#021">0.2.1</a>) and Entity Processor(<a href="/backstage-plugin-docs/release-notes/entity-processor/#021">0.2.1</a>) </span>
<strong>🎉 New release!</strong> <span style="margin-left: 20px;"> Checkout the latest versions for Frontend(<a href="/backstage-plugin-docs/release-notes/frontend/#0150">0.15.0</a>), Backend(<a href="/backstage-plugin-docs/release-notes/backend/#090">0.9.0</a>), Common(<a href="/backstage-plugin-docs/release-notes/common/#021">0.2.1</a>), Scaffolder Actions(<a href="/backstage-plugin-docs/release-notes/scaffolder-actions/#021">0.2.1</a>) and Entity Processor(<a href="/backstage-plugin-docs/release-notes/entity-processor/#030">0.3.0</a>) </span>
</p>
</div>
{% endblock %}

0 comments on commit e6031b0

Please sign in to comment.