Skip to content

Show --target-uploads-url and --use-github-storage in --help#1593

Merged
brianaj merged 3 commits into
mainfrom
1517-hide-storage-flags
Jul 9, 2026
Merged

Show --target-uploads-url and --use-github-storage in --help#1593
brianaj merged 3 commits into
mainfrom
1517-hide-storage-flags

Conversation

@brianaj

@brianaj brianaj commented Jul 9, 2026

Copy link
Copy Markdown
Collaborator

Summary

Unhides the --target-uploads-url and --use-github-storage options in --help output for the migrate-repo, migrate-org, and generate-script commands (where applicable) across the gei, bbs2gh, and gl2gh extensions.

Closes #1517. Supersedes #1518 (thanks @akordowski for the original attempt).

Motivation

Customers using non-github.com targets or GitHub-owned storage need to discover these options without reading source code. They've been hidden by default, which caused repeated confusion in support conversations.

Changes

Removed IsHidden = true from the option definitions in:

  • src/gei/Commands/MigrateRepo/MigrateRepoCommand.cs
  • src/gei/Commands/MigrateOrg/MigrateOrgCommand.cs
  • src/gei/Commands/GenerateScript/GenerateScriptCommand.cs
  • src/bbs2gh/Commands/MigrateRepo/MigrateRepoCommand.cs
  • src/bbs2gh/Commands/GenerateScript/GenerateScriptCommand.cs
  • src/gl2gh/Commands/MigrateRepo/MigrateRepoCommand.cs
  • src/gl2gh/Commands/GenerateScript/GenerateScriptCommand.cs

Updated the corresponding VerifyCommandOption assertions to expect the options to be visible.

Added a release note bullet to RELEASENOTES.md.

ado2gh is unaffected since it is a non archive path.

Verification

  • dotnet format src/OctoshiftCLI.sln — clean

  • dotnet build src/OctoshiftCLI.sln /p:TreatWarningsAsErrors=true — 0 warnings, 0 errors

  • dotnet test src/OctoshiftCLI.Tests/OctoshiftCLI.Tests.csproj — 1113 passed, 0 failed

  • Did you write/update appropriate tests

  • Release notes updated (if appropriate)

  • Appropriate logging output

  • Issue linked

  • Docs updated (or issue created)

  • New package licenses are added to ThirdPartyNotices.txt (if applicable)

@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown

Unit Test Results

    1 files      1 suites   25s ⏱️
1 112 tests 1 112 ✅ 0 💤 0 ❌
1 113 runs  1 113 ✅ 0 💤 0 ❌

Results for commit 779d7ce.

♻️ This comment has been updated with latest results.

@brianaj brianaj marked this pull request as ready for review July 9, 2026 22:32
Copilot AI review requested due to automatic review settings July 9, 2026 22:32

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR makes previously hidden CLI options discoverable by exposing --target-uploads-url and --use-github-storage in --help output for relevant migrate-repo, migrate-org, and generate-script commands across the gei, bbs2gh, and gl2gh extensions.

Changes:

  • Unhides --target-uploads-url and/or --use-github-storage by removing IsHidden = true from option definitions in the affected commands.
  • Updates unit tests to expect these options to be visible.
  • Adds a release note entry describing the new --help visibility.
Show a summary per file
File Description
src/gl2gh/Commands/MigrateRepo/MigrateRepoCommand.cs Removes hidden flag from --target-uploads-url and --use-github-storage options.
src/gl2gh/Commands/GenerateScript/GenerateScriptCommand.cs Removes hidden flag from --target-uploads-url and --use-github-storage options.
src/gei/Commands/MigrateRepo/MigrateRepoCommand.cs Removes hidden flag from --target-uploads-url and --use-github-storage options.
src/gei/Commands/MigrateOrg/MigrateOrgCommand.cs Removes hidden flag from --target-uploads-url option.
src/gei/Commands/GenerateScript/GenerateScriptCommand.cs Removes hidden flag from --target-uploads-url and --use-github-storage options.
src/bbs2gh/Commands/MigrateRepo/MigrateRepoCommand.cs Removes hidden flag from --target-uploads-url and --use-github-storage options.
src/bbs2gh/Commands/GenerateScript/GenerateScriptCommand.cs Removes hidden flag from --use-github-storage option.
src/OctoshiftCLI.Tests/gl2gh/Commands/MigrateRepo/MigrateRepoCommandTests.cs Updates assertions to expect options to be visible.
src/OctoshiftCLI.Tests/gl2gh/Commands/GenerateScript/GenerateScriptCommandTests.cs Updates assertions to expect options to be visible.
src/OctoshiftCLI.Tests/gei/Commands/MigrateRepo/MigrateRepoCommandTests.cs Updates assertions to expect options to be visible.
src/OctoshiftCLI.Tests/gei/Commands/MigrateOrg/MigrateOrgCommandTests.cs Updates assertions to expect --target-uploads-url to be visible.
src/OctoshiftCLI.Tests/gei/Commands/GenerateScript/GenerateScriptCommandTests.cs Updates assertions to expect options to be visible.
src/OctoshiftCLI.Tests/bbs2gh/Commands/MigrateRepo/MigrateRepoCommandTests.cs Updates assertions to expect options to be visible.
src/OctoshiftCLI.Tests/bbs2gh/Commands/GenerateScript/GenerateScriptCommandTests.cs Updates assertions to expect --use-github-storage to be visible.
RELEASENOTES.md Adds a bullet describing the newly visible --help options.

Review details

  • Files reviewed: 15/15 changed files
  • Comments generated: 1
  • Review effort level: Low

Comment thread src/bbs2gh/Commands/GenerateScript/GenerateScriptCommand.cs

@jeviet jeviet left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved -
Validated options - performed cursory check of spelling

@xiaonile xiaonile left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

@brianaj brianaj enabled auto-merge July 9, 2026 23:15
@brianaj brianaj merged commit e878584 into main Jul 9, 2026
36 checks passed
@brianaj brianaj deleted the 1517-hide-storage-flags branch July 9, 2026 23:35
@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown

Code Coverage

Package Line Rate Branch Rate Complexity Health
gei 81% 73% 608
gl2gh 77% 70% 417
ado2gh 71% 70% 749
Octoshift 80% 70% 1974
bbs2gh 83% 78% 668
Summary 79% (8809 / 11171) 72% (2203 / 3081) 4416

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

--target-uploads-url option marked as Hidden

5 participants