search

microsoft / vscode-azuretools

Common packages for building Azure extensions for VS Code
MIT License
106 stars 67 forks source link

auth: Add `AzureDevOpsSubscriptionProvider` documentation and workflow identity fedration guide to the README #1727

Closed hossam-nasr closed 6 months ago

hossam-nasr commented 6 months ago

[auth package] modify the README to add documentation of the newly created AzureDevOpsSubscriptionProvider, and include a guide on how to set up workflow identity federation on ADO to leverage that newly created class.

nturinski commented 6 months ago

Hmm, I agree that it should be its own file given now large it is.

Hossam also mentioned offline that it would be better to let users pass in the tenant id, service principal id, and the secret via parameters so they don't have to necessarily rely on the same exact environment variables that we are.

I agree with that idea since I'm sure people would like the option of being able to hard code the values for initial testing, acquire the values somewhere else, etc.

hossam-nasr commented 6 months ago

If it's going to be a separate file, where do you think it should live?

alexweininger commented 6 months ago

It can live in the root of this package.

hossam-nasr commented 6 months ago

Updated this to match the new constructor + moved the guide to a separate file + added more screenshots for easier guidance and readability :)

nturinski commented 6 months ago

These screenshots are 🔥

alexweininger commented 6 months ago

These screenshots are 🔥

Yeah was going to say this too. This is really great. I'm only a tiny bit worried about keeping this up-to-date, but 🤷

hossam-nasr commented 6 months ago

@bwateratmsft Good call out, done!

@nturinski @alexweininger @MicroFish91 This actually dismissed y'all's approval rip, can you approve again? <3