Merge pull request #1207 from github/timrogers/ado2gh-lock-repo-scopes

Update `ado2gh lock-repo` documentation to clarify required scopes fo…
github · Jan 12, 2024 · 6025a95 · 6025a95
2 parents 2e24a3e + 7dd8a72
commit 6025a95
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git 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
diff --git 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<string> AdoPat { get; } = new("--ado-pat");
+        public Option<string> AdoPat { get; } = new("--ado-pat")
+        {
+            Description = "An Azure DevOps personal access token with the 'Identity -> Read' and 'Security -> Manage' scopes."
+        };
         public Option<bool> Verbose { get; } = new("--verbose");
 
         public override LockRepoCommandHandler BuildHandler(LockRepoCommandArgs args, IServiceProvider sp)