Link GitLab export logs docs in export failure error message - #1615
Open
pmartindev wants to merge 4 commits into
Open
pmartindev wants to merge 4 commits into
pmartindev wants to merge 4 commits into
Conversation
Per team feedback (github#1607), rather than building a diagnostics/log-fetching command into GEI, point users to GitLab's own export/log documentation when an export fails so they can self-diagnose. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
6 tasks
Unit Test Results 1 files 1 suites 24s ⏱️ Results for commit eaf322b. |
|
Contributor
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
The URL fragment is invalid, and the changed failure message lacks test coverage.
Get a fresh assessment by requesting another Copilot review.
Review effort: Balanced
Findings: 1
Open (2)
What changed in this PR
Makes GitLab export failures more actionable without adding diagnostics tooling.
Changes:
- Adds GitLab log documentation guidance to the export failure message.
- Adds a release note.
| File | Description |
|---|---|
src/gl2gh/Commands/MigrateRepo/MigrateRepoCommandHandler.cs |
Adds documentation link to export failure. |
RELEASENOTES.md |
Documents the improved error guidance. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| if (ExportState.IsError(exportState)) | ||
| { | ||
| throw new OctoshiftCliException($"GitLab archive export failed!"); | ||
| throw new OctoshiftCliException($"GitLab archive export failed! Check your GitLab export logs for more details: https://docs.gitlab.com/administration/logs/#exporterlog"); |
| if (ExportState.IsError(exportState)) | ||
| { | ||
| throw new OctoshiftCliException($"GitLab archive export failed!"); | ||
| throw new OctoshiftCliException($"GitLab archive export failed! Check your GitLab export logs for more details: https://docs.gitlab.com/administration/logs/#exporterlog"); |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Per discussion on #1607, the team decided not to build a diagnostics/log-fetching command into GEI for GitLab export failures. Instead, this makes the existing generic error message actionable by pointing users at GitLab's own log documentation, so they can self-diagnose GitLab-side export failures or escalate to GitLab support.
Change
gl2gh migrate-repo's export failure now reads:Previously it only said:
This follows the same lightweight pattern as #1614: a focused error-message improvement plus a release note, without adding a new diagnostics surface area to GEI.
ThirdPartyNotices.txt(if applicable) -- N/AValidation
dotnet build src/OctoshiftCLI.sln /p:TreatWarningsAsErrors=truedotnet test src/OctoshiftCLI.Tests/OctoshiftCLI.Tests.csproj --filter 'FullyQualifiedName~MigrateRepoCommandHandlerTests'(110 passed)dotnet format src/OctoshiftCLI.sln(no changes needed)