feedback icon indicating copy to clipboard operation
feedback copied to clipboard

[Docs Update] Add OIDC setup and details

Open nora-shap opened this issue 1 year ago • 1 comments

Description

I recently re-enabled OIDC auth (only for GH with app integration!). It is not mentioned anywhere in the docs that we support this as an auth method. This is the current extent to which we acknowledge OIDC auth.

I think many current users would switch over to OIDC if they knew it was available and if we had clear setup instructions.

The reason we haven't added documentation is because we haven't done our due diligence in terms of testing the setup with OIDC. We need to walk through the steps to document use - both for an existing repo converting to OIDC and setting up as a new user with OIDC. If we could set up canary repos that use OIDC, we could point to them in the docs, as well as have a way to know if we've accidentally made breaking changes.

Page(s)

Unfortunately, we would need to change every place we reference codecov token requirement, starting with the new repo page in gazebo (CoverageOnboarding/NewRepoTab, screenshot below), since if you're using OIDC you don't need to do the stuff with the repository upload token (I haven't tested this, this is an assumption).

https://docs.codecov.com/docs/quick-start#step-2-get-the-repository-upload-token

Current State

[] Broken Link [] Unclear Language [] Inconsistent Formatting [x] Missing Information [x] Missing Updates for New Features [] Deprecated Features

Additional Information

Screenshot 2024-05-30 at 10 28 49 AM

nora-shap avatar May 30 '24 17:05 nora-shap