Skip to content

Add GitHub App auth provider #15500

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.

Sign up for GitHub

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

Jump to bottom
Merged
eva-vashkevich merged 14 commits into from
Oct 15, 2025
Merged

Add GitHub App auth provider #15500

eva-vashkevich merged 14 commits into from
Oct 15, 2025

Conversation

@rak-phillip
Copy link
Member

@rak-phillip rak-phillip commented Sep 22, 2025 •
edited
Loading

Summary

This adds a new GitHub App auth provider.

Fixes #14796

Occurred changes and/or fixed issues

  • Add the github app auth provider
  • Add validation to github and github app forms
  • Add e2e tests for the github app auth provider

Technical notes summary

Similar to other auth providers, this change utilizes existing functionality to allow the GitHub App auth provider to function - meaning that the GitHub auth provider has been modified to support this feature in order to cut down on duplication.

There are two new "steps" components, which render the instructions for the github auth providers. These can be distilled down into a single component, driven by data to properly render contents, but I thought the two component approach to be more straightforward for now.

Areas or cases that should be tested

  • GitHub auth provider
  • GitHub App auth provider

Areas which could experience regressions

  • GitHub auth provider

Screenshot/Video

image image

Checklist

  • The PR is linked to an issue and the linked issue has a Milestone, or no issue is needed
  • The PR has a Milestone
  • The PR template has been filled out
  • The PR has been self reviewed
  • The PR has a reviewer assigned
  • The PR has automated tests or clear instructions for manual tests and the linked issue has appropriate QA labels, or tests are not needed
  • The PR has reviewed with UX and tested in light and dark mode, or there are no UX changes
  • The PR has been reviewed in terms of Accessibility

@rancher-ui-project-bot rancher-ui-project-bot bot added this to the v2.13.0 milestone Sep 22, 2025
@rak-phillip rak-phillip force-pushed the task/14796-github-app-auth-provider branch from 80d5fbe to bb31446 Compare September 22, 2025 17:30
@rak-phillip
Copy link
Member Author

rak-phillip commented Sep 22, 2025

@eva-vashkevich simplified instructions for creating a new GitHub app can be found at: https://confluence.suse.com/spaces/CU/pages/1903427936/GitHub+App

@rak-phillip rak-phillip force-pushed the task/14796-github-app-auth-provider branch 2 times, most recently from 8215d27 to 99ac3d1 Compare September 22, 2025 23:36
eva-vashkevich
eva-vashkevich previously approved these changes Sep 23, 2025
View reviewed changes
Copy link
Member

@eva-vashkevich eva-vashkevich left a comment

Choose a reason for hiding this comment

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

lgtm

eva-vashkevich
eva-vashkevich reviewed Sep 26, 2025
View reviewed changes
shell/assets/translations/en-us.yaml
2: <li>Click "Generate a new client secret"</li>
3: <li>Click "Generate a private key"</li>
4: <li>Copy and paste the App ID, Client ID, Client Secret, and Private Key of your newly created OAuth app into the fields below</li>
1: <li>Under Client Secrets, click "Generate a new client secret"</li>
Copy link
Member

@eva-vashkevich eva-vashkevich Sep 26, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Should these be in quotes too? And the next two lines

Copy link
Member Author

@rak-phillip rak-phillip Sep 30, 2025

Choose a reason for hiding this comment

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

Just for clarity, what are these that you are referencing? I think that the convention I was going for was that targets of actions would be contained within quotation marks - for example, Click "Some label". With this in mind, I think that the targets of Copy & Paste can be contained in quotation marks.

With the current iteration, there's only one line below 521.. I think I've addressed the changes, but let me know if anything is missing.

@rak-phillip rak-phillip force-pushed the task/14796-github-app-auth-provider branch from 2d5f111 to dea6b0f Compare September 30, 2025 16:24
eva-vashkevich
eva-vashkevich approved these changes Oct 2, 2025
View reviewed changes
Copy link
Member

@eva-vashkevich eva-vashkevich left a comment

Choose a reason for hiding this comment

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

lgtm

@rak-phillip rak-phillip force-pushed the task/14796-github-app-auth-provider branch from dea6b0f to e5e8581 Compare October 10, 2025 18:11
@rak-phillip
Add github app to list of auth providers
6482ec6 
Signed-off-by: Phillip Rak <[email protected]>
@rak-phillip
Add github app auth form
237f575 
Signed-off-by: Phillip Rak <[email protected]>
@rak-phillip
Multiline input
abdb68f 
Signed-off-by: Phillip Rak <[email protected]>
@rak-phillip
Add instructions for registering github app
2accc31 
Signed-off-by: Phillip Rak <[email protected]>
@rak-phillip
Add additional warning for github app
0fd4fb7 
Signed-off-by: Phillip Rak <[email protected]>
@rak-phillip
Move private key input to end of form
4ac1367 
Signed-off-by: Phillip Rak <[email protected]>
@rak-phillip
Add required fields for github app auth
2d292e2 
Signed-off-by: Phillip Rak <[email protected]>
@rak-phillip
Add tests for github app auth
a244f0c 
Signed-off-by: Phillip Rak <[email protected]>
@rak-phillip
Rename NAME prop to name
2da81e7 
Signed-off-by: Phillip Rak <[email protected]>
@rak-phillip
Add secondary rolw to file upload button
98a29f9 
Signed-off-by: Phillip Rak <[email protected]>
@rak-phillip
Update the name of the form if github app is selected
11411bd 
Signed-off-by: Phillip Rak <[email protected]>
@rak-phillip
Fix clientId display
5844d31 
Signed-off-by: Phillip Rak <[email protected]>
@rak-phillip
Fix Github App ID label
db50fcb 
Signed-off-by: Phillip Rak <[email protected]>
@rak-phillip
Update instructions
40b5058 
Signed-off-by: Phillip Rak <[email protected]>
@rak-phillip rak-phillip force-pushed the task/14796-github-app-auth-provider branch from e5e8581 to 40b5058 Compare October 10, 2025 19:39
@rak-phillip
Copy link
Member Author

rak-phillip commented Oct 10, 2025

This depends on rancher/rancher#51686

@gaktive
Copy link
Member

gaktive commented Oct 14, 2025

Backend now merged so this can now do the same once CI passes.

@eva-vashkevich
Copy link
Member

eva-vashkevich commented Oct 15, 2025

Tested with latest backend. everything seems to work fine

@eva-vashkevich eva-vashkevich merged commit 970a8df into rancher:master Oct 15, 2025
113 of 118 checks passed
@rak-phillip rak-phillip deleted the task/14796-github-app-auth-provider branch October 20, 2025 15:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@eva-vashkevich eva-vashkevich eva-vashkevich approved these changes

Assignees

@rak-phillip rak-phillip

Labels

None yet

Projects

None yet

Milestone

v2.13.0

Development

Successfully merging this pull request may close these issues.

Support new Github App auth provider

3 participants

@rak-phillip @gaktive @eva-vashkevich