Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: ensure secret configuration values are secret #36

Merged
merged 1 commit into from
Mar 1, 2024

Conversation

alecjacobs5401
Copy link
Contributor

@alecjacobs5401 alecjacobs5401 commented Mar 1, 2024

Description

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

See related PagerDuty/backstage-plugin#78 to remove configuration from the frontend plugin.

Type of change

  • New feature (non-breaking change which adds functionality)
  • Fix (non-breaking change which fixes an issue)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist

  • I have performed a self-review of this change
  • Changes have been tested
  • Changes are documented
  • Changes generate no new warnings
  • PR title follows conventional commit semantics

If this is a breaking change 👇

  • I have documented the migration process
  • I have implemented necessary warnings (if it can live side by side)

Acknowledgement

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

Copy link
Contributor

@t1agob t1agob left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved. Will also approve the PR for the frontend plugin as they only work together.

@t1agob t1agob merged commit 924b405 into PagerDuty:next Mar 1, 2024
1 check passed
t1agob added a commit to PagerDuty/backstage-plugin that referenced this pull request Mar 1, 2024
### Description

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.

See PagerDuty/backstage-plugin-backend#36 for a
related PR to mark those configuration values as secret.

### Type of change

- [ ] New feature (non-breaking change which adds functionality)
- [x] Fix (non-breaking change which fixes an issue)
- [ ] Breaking change (fix or feature that would cause existing
functionality to not work as expected)

### Checklist

- [x] I have performed a self-review of this change
- [x] Changes have been tested
- [x] Changes are documented
- [x] Changes generate *no new warnings*
- [x] PR title follows [conventional commit
semantics](https://www.conventionalcommits.org/en/v1.0.0/)

If this is a breaking change 👇

- [ ] I have documented the migration process
- [ ] I have implemented necessary warnings (if it can live side by
side)

## Acknowledgement

By submitting this pull request, I confirm that you can use, modify,
copy, and redistribute this contribution, under the terms of your
choice.

**Disclaimer:** We value your time and bandwidth. As such, any pull
requests created on non-triaged issues might not be successful.
@alecjacobs5401 alecjacobs5401 deleted the config_visibility branch March 1, 2024 18:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants