Merge pull request #1197 from github/timrogers-patch-1

Document that `bbs2gh inventory-report` doesn't return personal repos
github · Dec 22, 2023 · 2e24a3e · 2e24a3e
2 parents ef6198a + ad0bd3c
commit 2e24a3e
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/RELEASENOTES.md b/RELEASENOTES.md
@@ -1 +1 @@
-
+- Update `bbs2gh inventory-report` help text to document that personal repositories owned by users are not supported
diff --git a/src/bbs2gh/Commands/InventoryReport/InventoryReportCommand.cs b/src/bbs2gh/Commands/InventoryReport/InventoryReportCommand.cs
@@ -11,7 +11,7 @@ public class InventoryReportCommand : CommandBase<InventoryReportCommandArgs, In
     {
         public InventoryReportCommand() : base(
                 name: "inventory-report",
-                description: "Generates several CSV files containing lists of BBS projects and repos. Useful for planning large migrations." +
+                description: "Generates several CSV files containing lists of BBS projects and repos. Useful for planning large migrations. Personal repositories owned by individual users will not be included." +
                              Environment.NewLine +
                              "Note: Expects BBS_USERNAME and BBS_PASSWORD env variables or --bbs-username and --bbs-password options to be set.")
         {