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

scaffolder: replace ui:widget: password with a warning message #24834

Merged
merged 6 commits into from
Jun 18, 2024

Conversation

benjdlambert
Copy link
Member

@benjdlambert benjdlambert commented May 20, 2024

This could be controversial, as this could potentially break a few templates.

If you're currently using ui:widget: password and then using ${{ parameters.myParam }} then this will need updating to ${{ secrets.myParam }} instead, as the current approach is not secure.

Replaces the build in ui:widget: password with our own component which warns that template authors should not be using it as it's not secure and some docs on how to use the ui:field: Secret instead.

EDIT: Ended up going with the second option here instead for now in order to not break any templates, and the ui:field: Secret not been so battletested yet.

@benjdlambert benjdlambert requested review from a team as code owners May 20, 2024 12:13
@github-actions github-actions bot added the area:scaffolder Everything and all things related to the scaffolder project area label May 20, 2024
@backstage-goalie
Copy link
Contributor

backstage-goalie bot commented May 20, 2024

Changed Packages

Package Name Package Path Changeset Bump Current Version
@backstage/plugin-scaffolder-react plugins/scaffolder-react minor v1.8.7-next.3
@backstage/plugin-scaffolder plugins/scaffolder minor v1.21.0-next.3

@acierto
Copy link
Contributor

acierto commented May 30, 2024

As for me both approaches are fine as soon as this will be clear to the user during upgrade.

Copy link
Contributor

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

Signed-off-by: blam <ben@blam.sh>
Signed-off-by: blam <ben@blam.sh>
@benjdlambert benjdlambert changed the title scaffolder: replace ui:widget: password with ui:field: Secret implementation scaffolder: replace ui:widget: password with a warning message Jun 14, 2024
Signed-off-by: blam <ben@blam.sh>
Signed-off-by: blam <ben@blam.sh>
Signed-off-by: blam <ben@blam.sh>
@benjdlambert benjdlambert merged commit cd09d4f into master Jun 18, 2024
26 checks passed
@benjdlambert benjdlambert deleted the blam/replace-password-widget branch June 18, 2024 08:48
Copy link
Contributor

Thank you for contributing to Backstage! The changes in this pull request will be part of the 1.28.0 release, scheduled for Tue, 18 Jun 2024.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:scaffolder Everything and all things related to the scaffolder project area
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants