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

feat: new UI to clarify adding token #3552

Merged
merged 12 commits into from
Dec 13, 2024
Merged

feat: new UI to clarify adding token #3552

merged 12 commits into from
Dec 13, 2024

Conversation

calvin-codecov
Copy link
Contributor

@calvin-codecov calvin-codecov commented Dec 4, 2024

Description

Closes codecov/engineering-team#2698

Figma: https://www.figma.com/design/ZJmSdJUIz03zJdF22kLhAs/GH-2694?node-id=2058-3163&t=koQcNbcBaHcFN7rk-1 There are two versions in the file. Check the higher up version that is labeled "Latest".

With the addition of org level tokens and token auth possibly being required for an org, we have multiple variations as outlined in the figma file.

Landing on this repo onboarding page...

  • the org token may or may not have been previously generated (could have been generated in their settings)
  • the org may or may not require token authentication (this is set in their settings)
  • the user may be an admin or just a regular member

Easiest way to test on preview:
If you have any repos on your personal org, go to the onboarding for one.

  • Check what the steps look like without org token generated for both "token required" and "not token required" (setting can be changed in in the "Settings" tab -> Global Upload Token on org level.
  • Click "Generate" on onboarding step and check what the steps look like for both token required/not required

Notable Changes

I changed the Step components to move away from naming with number specific names and I also split them out from GitHubActions.tsx as that file was getting quite large.

Screenshots

I've only expanded the screenshot example for "Token required - Prev Generated" but all of the others would look the same.

Token required - Not Prev Generated
Required - No Prev
Token required - Not Prev Generated but newly generated in this flow
Required - Generated
Token required - Repo instruction chosen (Not Prev Generated)
Required - Repo Chosen
Token required - Prev Generated
Required - Prev

Token optional - Not Prev Generated
Optional - No Prev
Token optional - Prev Generated
Optional - Prev
Token optional - Not Prev Generated but newly generated in this flow
Optional - Generated

Non-admin Disabled Generated Button
NonAdmin

Light mode screenshot
Screenshot 2024-12-12 at 3 12 17 PM

Link to Sample Entry

Legal Boilerplate

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. In 2022 this entity acquired Codecov and as result Sentry is going to need some rights from me in order to utilize my contributions in this PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

@codecov-staging
Copy link

codecov-staging bot commented Dec 4, 2024

Bundle Report

Changes will increase total bundle size by 653.38kB (3.73%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
gazebo-staging-system-esm 6.05MB 326.71kB (5.71%) ⬆️
gazebo-staging-system 6.0MB 326.67kB (5.76%) ⬆️

Copy link

codecov bot commented Dec 4, 2024

Bundle Report

Changes will increase total bundle size by 653.38kB (3.73%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
gazebo-production-system 6.0MB 326.67kB (5.76%) ⬆️
gazebo-production-system-esm 6.05MB 326.71kB (5.71%) ⬆️

@codecov-staging
Copy link

codecov-staging bot commented Dec 4, 2024

Codecov Report

Attention: Patch coverage is 96.70330% with 3 lines in your changes missing coverage. Please review.

✅ All tests successful. No failed tests found.

Files with missing lines Patch % Lines
...age/CoverageOnboarding/GitHubActions/TokenStep.tsx 96.15% 2 Missing ⚠️
...verageOnboarding/GitHubActions/WorkflowYMLStep.tsx 90.90% 1 Missing ⚠️
@@            Coverage Diff             @@
##             main    #3552      +/-   ##
==========================================
- Coverage   98.91%   98.90%   -0.01%     
==========================================
  Files         806      810       +4     
  Lines       14499    14563      +64     
  Branches     4114     4152      +38     
==========================================
+ Hits        14342    14404      +62     
- Misses        150      152       +2     
  Partials        7        7              
Files with missing lines Coverage Δ
...CoverageOnboarding/GitHubActions/GitHubActions.tsx 100.00% <100.00%> (+2.32%) ⬆️
...age/CoverageOnboarding/GitHubActions/MergeStep.tsx 100.00% <100.00%> (ø)
...ageOnboarding/GitHubActions/OutputCoverageStep.tsx 100.00% <100.00%> (ø)
...codecovEventMetrics/useStoreCodecovEventMetric.tsx 100.00% <ø> (ø)
src/services/navigation/useNavLinks/useNavLinks.ts 99.01% <100.00%> (+<0.01%) ⬆️
...ices/orgUploadToken/useRegenerateOrgUploadToken.js 100.00% <100.00%> (ø)
...verageOnboarding/GitHubActions/WorkflowYMLStep.tsx 90.90% <90.90%> (ø)
...age/CoverageOnboarding/GitHubActions/TokenStep.tsx 96.15% <96.15%> (ø)
Components Coverage Δ
Assets 100.00% <ø> (ø)
Layouts 99.71% <ø> (ø)
Pages 98.58% <96.59%> (-0.02%) ⬇️
Services 99.36% <100.00%> (+<0.01%) ⬆️
Shared 99.32% <ø> (ø)
UI 99.14% <ø> (ø)

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 637e1a3...00707c0. Read the comment docs.

Copy link

codecov-public-qa bot commented Dec 4, 2024

Codecov Report

Attention: Patch coverage is 96.70330% with 3 lines in your changes missing coverage. Please review.

Project coverage is 98.90%. Comparing base (637e1a3) to head (00707c0).
Report is 1 commits behind head on main.

✅ All tests successful. No failed tests found.

Files with missing lines Patch % Lines
...age/CoverageOnboarding/GitHubActions/TokenStep.tsx 96.15% 2 Missing ⚠️
...verageOnboarding/GitHubActions/WorkflowYMLStep.tsx 90.90% 1 Missing ⚠️
@@            Coverage Diff             @@
##             main    #3552      +/-   ##
==========================================
- Coverage   98.91%   98.90%   -0.01%     
==========================================
  Files         806      810       +4     
  Lines       14499    14563      +64     
  Branches     4114     4145      +31     
==========================================
+ Hits        14342    14404      +62     
- Misses        150      152       +2     
  Partials        7        7              
Files with missing lines Coverage Δ
...CoverageOnboarding/GitHubActions/GitHubActions.tsx 100.00% <100.00%> (+2.32%) ⬆️
...age/CoverageOnboarding/GitHubActions/MergeStep.tsx 100.00% <100.00%> (ø)
...ageOnboarding/GitHubActions/OutputCoverageStep.tsx 100.00% <100.00%> (ø)
...codecovEventMetrics/useStoreCodecovEventMetric.tsx 100.00% <ø> (ø)
src/services/navigation/useNavLinks/useNavLinks.ts 99.01% <100.00%> (+<0.01%) ⬆️
...ices/orgUploadToken/useRegenerateOrgUploadToken.js 100.00% <100.00%> (ø)
...verageOnboarding/GitHubActions/WorkflowYMLStep.tsx 90.90% <90.90%> (ø)
...age/CoverageOnboarding/GitHubActions/TokenStep.tsx 96.15% <96.15%> (ø)
Components Coverage Δ
Assets 100.00% <ø> (ø)
Layouts 99.71% <ø> (ø)
Pages 98.58% <96.59%> (-0.02%) ⬇️
Services 99.36% <100.00%> (+<0.01%) ⬆️
Shared 99.32% <ø> (ø)
UI 99.14% <ø> (ø)

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 637e1a3...00707c0. Read the comment docs.

@codecov-qa
Copy link

codecov-qa bot commented Dec 4, 2024

Codecov Report

Attention: Patch coverage is 96.70330% with 3 lines in your changes missing coverage. Please review.

Project coverage is 98.90%. Comparing base (637e1a3) to head (00707c0).
Report is 1 commits behind head on main.

✅ All tests successful. No failed tests found.

Files with missing lines Patch % Lines
...age/CoverageOnboarding/GitHubActions/TokenStep.tsx 96.15% 2 Missing ⚠️
...verageOnboarding/GitHubActions/WorkflowYMLStep.tsx 90.90% 1 Missing ⚠️
@@            Coverage Diff             @@
##             main    #3552      +/-   ##
==========================================
- Coverage   98.91%   98.90%   -0.01%     
==========================================
  Files         806      810       +4     
  Lines       14499    14563      +64     
  Branches     4121     4152      +31     
==========================================
+ Hits        14342    14404      +62     
- Misses        150      152       +2     
  Partials        7        7              
Files with missing lines Coverage Δ
...CoverageOnboarding/GitHubActions/GitHubActions.tsx 100.00% <100.00%> (+2.32%) ⬆️
...age/CoverageOnboarding/GitHubActions/MergeStep.tsx 100.00% <100.00%> (ø)
...ageOnboarding/GitHubActions/OutputCoverageStep.tsx 100.00% <100.00%> (ø)
...codecovEventMetrics/useStoreCodecovEventMetric.tsx 100.00% <ø> (ø)
src/services/navigation/useNavLinks/useNavLinks.ts 99.01% <100.00%> (+<0.01%) ⬆️
...ices/orgUploadToken/useRegenerateOrgUploadToken.js 100.00% <100.00%> (ø)
...verageOnboarding/GitHubActions/WorkflowYMLStep.tsx 90.90% <90.90%> (ø)
...age/CoverageOnboarding/GitHubActions/TokenStep.tsx 96.15% <96.15%> (ø)
Components Coverage Δ
Assets 100.00% <ø> (ø)
Layouts 99.71% <ø> (ø)
Pages 98.58% <96.59%> (-0.02%) ⬇️
Services 99.36% <100.00%> (+<0.01%) ⬆️
Shared 99.32% <ø> (ø)
UI 99.14% <ø> (ø)

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 637e1a3...00707c0. Read the comment docs.

Copy link

codecov bot commented Dec 4, 2024

Codecov Report

Attention: Patch coverage is 96.70330% with 3 lines in your changes missing coverage. Please review.

Project coverage is 98.90%. Comparing base (637e1a3) to head (00707c0).
Report is 1 commits behind head on main.

✅ All tests successful. No failed tests found.

Files with missing lines Patch % Lines
...age/CoverageOnboarding/GitHubActions/TokenStep.tsx 96.15% 2 Missing ⚠️
...verageOnboarding/GitHubActions/WorkflowYMLStep.tsx 90.90% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3552      +/-   ##
==========================================
- Coverage   98.91%   98.90%   -0.01%     
==========================================
  Files         806      810       +4     
  Lines       14499    14563      +64     
  Branches     4114     4152      +38     
==========================================
+ Hits        14342    14404      +62     
- Misses        150      152       +2     
  Partials        7        7              
Files with missing lines Coverage Δ
...CoverageOnboarding/GitHubActions/GitHubActions.tsx 100.00% <100.00%> (+2.32%) ⬆️
...age/CoverageOnboarding/GitHubActions/MergeStep.tsx 100.00% <100.00%> (ø)
...ageOnboarding/GitHubActions/OutputCoverageStep.tsx 100.00% <100.00%> (ø)
...codecovEventMetrics/useStoreCodecovEventMetric.tsx 100.00% <ø> (ø)
src/services/navigation/useNavLinks/useNavLinks.ts 99.01% <100.00%> (+<0.01%) ⬆️
...ices/orgUploadToken/useRegenerateOrgUploadToken.js 100.00% <100.00%> (ø)
...verageOnboarding/GitHubActions/WorkflowYMLStep.tsx 90.90% <90.90%> (ø)
...age/CoverageOnboarding/GitHubActions/TokenStep.tsx 96.15% <96.15%> (ø)
Components Coverage Δ
Assets 100.00% <ø> (ø)
Layouts 99.71% <ø> (ø)
Pages 98.58% <96.59%> (-0.02%) ⬇️
Services 99.36% <100.00%> (+<0.01%) ⬆️
Shared 99.32% <ø> (ø)
UI 99.14% <ø> (ø)

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 637e1a3...00707c0. Read the comment docs.

@codecov-releaser
Copy link
Contributor

codecov-releaser commented Dec 4, 2024

✅ Deploy preview for gazebo ready!

Previews expire after 1 month automatically.

Storybook

Commit Created Cloud Enterprise
ab44440 Wed, 04 Dec 2024 12:35:35 GMT Expired Expired
e562d13 Thu, 05 Dec 2024 07:07:30 GMT Expired Expired
5900cd2 Thu, 05 Dec 2024 07:43:01 GMT Expired Expired
eea43c5 Thu, 05 Dec 2024 17:34:26 GMT Expired Expired
326c304 Wed, 11 Dec 2024 19:16:54 GMT Expired Expired
326c304 Wed, 11 Dec 2024 19:23:39 GMT Expired Expired
16f2bb2 Thu, 12 Dec 2024 08:04:41 GMT Expired Expired
9cf61eb Thu, 12 Dec 2024 08:17:13 GMT Expired Expired
3e1b759 Thu, 12 Dec 2024 20:20:53 GMT Expired Expired
c4fc332 Fri, 13 Dec 2024 17:04:22 GMT Expired Expired
c4fc332 Fri, 13 Dec 2024 17:04:58 GMT Expired Expired
61604f7 Fri, 13 Dec 2024 19:38:23 GMT Expired Expired
43ff5c6 Fri, 13 Dec 2024 20:18:31 GMT Expired Expired
00707c0 Fri, 13 Dec 2024 21:09:05 GMT Cloud Enterprise

@calvin-codecov calvin-codecov force-pushed the cy/add_token_clear branch 2 times, most recently from eea43c5 to 524e99e Compare December 11, 2024 19:11
Copy link
Contributor

@nicholas-codecov nicholas-codecov left a comment

Choose a reason for hiding this comment

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

One small comment, rest looks great!

Comment on lines 7 to 8
describe('MergeStep', () => {
describe('MergeStep', () => {
Copy link
Contributor

Choose a reason for hiding this comment

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

👀 can we get rid of the duplicate describes?

@calvin-codecov calvin-codecov added this pull request to the merge queue Dec 13, 2024
Merged via the queue into main with commit 400d724 Dec 13, 2024
50 of 62 checks passed
@calvin-codecov calvin-codecov deleted the cy/add_token_clear branch December 13, 2024 21:10
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.

Adding a token should be more clear
3 participants