Skip to content

Commit

Permalink
docs: updated backstage config visibility
Browse files Browse the repository at this point in the history
Signed-off-by: Tiago Barbosa <[email protected]>
  • Loading branch information
t1agob committed Mar 1, 2024
1 parent c66d25a commit 80bade2
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 1 deletion.
14 changes: 14 additions & 0 deletions docs/release-notes/backend.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
# Release notes for Backend plugin

## > 0.4.5

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

### Summary

This release updates the `config.d.ts` values to mark `pagerDuty.apiToken` and `pagerDuty.oauth` as secret values.

These are only used by the backend currently and should not be made visible to the frontend. See <https://backstage.io/docs/conf/defining/#visibility> for more details.

### Changes

- fix: ensure secret configuration values are secret

## > 0.4.4

[GitHub release](https://github.com/PagerDuty/backstage-plugin-backend/releases/tag/0.4.4)
Expand Down
10 changes: 10 additions & 0 deletions docs/release-notes/frontend.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# Release notes for Frontend plugin

## > 0.9.3

[GitHub release](https://github.com/PagerDuty/backstage-plugin/releases/tag/0.9.3This release removes the `pagerDuty.apiToken` and `pagerDuty.oauth` configuration definitions from this repository as they should be treated as secret config and this frontend plugin does not need to know about them.

These configurations will now be exclusive to the backend plugin.

### Changes

- fix: remove config definitions that are secret

## > 0.9.2

[GitHub release](https://github.com/PagerDuty/backstage-plugin/releases/tag/0.9.2)
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="/release-notes/frontend/#092">0.9.2</a>), Backend(<a href="/release-notes/backend/#044">0.4.4</a>) and Common(<a href="/release-notes/common/#011">0.1.1</a>) </span>
<strong>🎉 New release!</strong> <span style="margin-left: 20px;"> Checkout the latest versions for Frontend(<a href="/release-notes/frontend/#093">0.9.3</a>), Backend(<a href="/release-notes/backend/#045">0.4.5</a>) and Common(<a href="/release-notes/common/#011">0.1.1</a>) </span>
</p>
</div>
{% endblock %}

0 comments on commit 80bade2

Please sign in to comment.