From 7dd8a729b2e4afb1e709875ec4bd7484358d967c Mon Sep 17 00:00:00 2001 From: Tim Rogers Date: Fri, 12 Jan 2024 17:11:26 +0000 Subject: [PATCH] Update `ado2gh lock-repo` documentation to clarify required scopes for yout ADO PAT --- RELEASENOTES.md | 1 + src/ado2gh/Commands/LockRepo/LockRepoCommand.cs | 5 ++++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/RELEASENOTES.md b/RELEASENOTES.md index 7220a130..311acf63 100644 --- a/RELEASENOTES.md +++ b/RELEASENOTES.md @@ -1 +1,2 @@ - Update `bbs2gh inventory-report` help text to document that personal repositories owned by users are not supported +- Update `ado2gh lock-repo` help text to document the scopes required for your Azure DevOps personal access token \ No newline at end of file diff --git a/src/ado2gh/Commands/LockRepo/LockRepoCommand.cs b/src/ado2gh/Commands/LockRepo/LockRepoCommand.cs index 1da1bb7d..068b537b 100644 --- a/src/ado2gh/Commands/LockRepo/LockRepoCommand.cs +++ b/src/ado2gh/Commands/LockRepo/LockRepoCommand.cs @@ -34,7 +34,10 @@ public LockRepoCommand() : base( { IsRequired = true }; - public Option AdoPat { get; } = new("--ado-pat"); + public Option AdoPat { get; } = new("--ado-pat") + { + Description = "An Azure DevOps personal access token with the 'Identity -> Read' and 'Security -> Manage' scopes." + }; public Option Verbose { get; } = new("--verbose"); public override LockRepoCommandHandler BuildHandler(LockRepoCommandArgs args, IServiceProvider sp)