timrogers / gh-migration-audit

Audits GitHub repositories to highlight data that cannot be automatically migrated using GitHub's migration tools
MIT License
9 stars 3 forks source link

feat: add support for GitHub Enterprise Cloud with data residency #226

Closed timrogers closed 4 weeks ago

timrogers commented 1 month ago

[!IMPORTANT] Add support for GitHub Enterprise Cloud with data residency by updating base URL handling and documentation.

  • Behavior:
    • Adds support for GitHub Enterprise Cloud with data residency by recognizing .ghe.com in base URLs in github-products.ts.
    • Updates --base-url option descriptions in audit-all.ts, audit-repo.ts, and audit-repos.ts to include GitHub Enterprise Cloud with data residency.
  • Documentation:
    • Updates README.md to include GitHub Enterprise Cloud with data residency in migration scenarios and API base URL examples.

This description was created by Ellipsis for c1a7f1cc674e0f8bcc162d538d7c10afdb27c182. It will automatically update as commits are pushed.

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

[!WARNING]

Rate limit exceeded

@timrogers has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 14 minutes and 29 seconds before requesting another review.

⌛ How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
🚦 How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
📥 Commits Files that changed from the base of the PR and between c1a7f1cc674e0f8bcc162d538d7c10afdb27c182 and fa12d4e7a88a6f5725fe29eb783d60c85c10cddb.

Walkthrough

The changes encompass updates to the README.md file for clearer migration path descriptions, enhancements to command-line options and error handling in multiple command files (audit-all.ts, audit-repo.ts, audit-repos.ts), and the introduction of new utility functions in github-products.ts. The modifications improve clarity in usage instructions, error messaging, and logging, while also defining new types and functions to better handle GitHub server information.

Changes

File(s) Change Summary
README.md Clarified migration paths for gh-migration-audit tool, specifying supported GitHub platforms and updating usage comments for API endpoint guidance.
src/commands/audit-all.ts, src/commands/audit-repo.ts Enhanced descriptions for --base-url option, providing clearer guidance on usage for GitHub products; no changes to command logic or functionality.
src/commands/audit-repos.ts Updated CLI options for --base-url, refined error handling for CSV input, added checks for existing output files, and improved logging for repository counts.
src/github-products.ts Introduced new utility functions for GitHub server type detection, added GhesMetaResponse type, and updated getGitHubProductInformation function.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant GitHubAPI

    User->>CLI: Execute audit command
    CLI->>GitHubAPI: Validate access token
    GitHubAPI-->>CLI: Token valid
    CLI->>GitHubAPI: Fetch repository data
    GitHubAPI-->>CLI: Return repository data
    CLI->>User: Display audit results

Poem

🐰 In the land of code where rabbits play,
Changes hop in a bright new way.
With clearer paths and options wide,
Auditing now is a joyful ride!
So let us cheer, with a twitch of our nose,
For better tools, as the garden grows! 🌼


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
github-actions[bot] commented 1 month ago

Test Results

0 tests  ±0   0 :white_check_mark: ±0   0s :stopwatch: ±0s 0 suites ±0   0 :zzz: ±0  0 files   ±0   0 :x: ±0 

Results for commit fa12d4e7. ± Comparison against base commit 8a08c346.

:recycle: This comment has been updated with latest results.