How to migrate issues from a private GitHub repository using this script?

Configure authentication in the config.ini file or use command-line flags like -u and -p for credentials. The script handles private repos by requiring appropriate GitHub tokens or passwords, as noted in the README.

Does GitHub Issues Import preserve the original authors of comments?

No, all imported comments are attributed to a single user account from the config. Original authors are only referenced in text headers within the imported comments, which can dilute accountability.

Can I import pull requests as actual pull requests with this tool?

No, pull requests are converted to issues with links to the original code. The README explicitly states that they become new issues in the target repository, requiring manual code integration.

What's better for issue migration: GitHub Issues Import or GitHub's native import feature?

GitHub's native tool is simpler for basic imports but may not handle private repos or unrelated repositories. This script offers more flexibility for cross-repo migrations and custom templates, but requires setup and has security trade-offs.

How to customize the templates for imported issues?

Edit the Markdown files in the templates directory or specify custom template paths in the config file. The README provides details on template structure and options for tailoring issue formatting.

Is there a way to avoid plain-text password storage with this script?

Yes, use command-line arguments -u and -p to pass credentials at runtime instead of storing them in config.ini. The README warns about plain-text risks and recommends this approach for better security.

Open-Awesome

github-issues-import

MITPython

A Python script to import issues and pull requests from one GitHub repository to another, even across unrelated private repos.

Visit Website GitHub

428 stars170 forks0 contributors

What is github-issues-import?

GitHub Issues Import is a Python script designed to migrate issues, pull requests, and associated metadata from one GitHub repository to another. It solves the problem of consolidating or transferring issue tracking data during repository migrations, merges, or archival, even when repositories are unrelated or private.

Target Audience

Developers, repository maintainers, and DevOps engineers who need to move issue tracking data between GitHub repositories, such as during project consolidation, migration to a new organization, or when archiving old projects.

Value Proposition

It provides a straightforward, scriptable solution for GitHub issue migration without requiring manual copy-pasting, preserving comments, labels, and milestones while handling authentication for private repos.

Overview

Python script to import issues from one repository into another, either one at a time or all of them at once.

Use Cases

Best For

Migrating issue history when moving a project to a new GitHub repository
Consolidating issues from multiple repositories into a single one
Archiving old projects while preserving their issue tracking data
Transferring issues between unrelated private repositories
Automating issue migration during repository merges or splits
Preserving pull request discussions as issues in a new repository

Not Ideal For

Teams requiring real-time, bidirectional synchronization of issues between repositories
Projects that need to preserve pull requests as functional pull requests with code diffs and merge capabilities
Organizations with strict security policies that prohibit any plain-text credential storage
Users who prefer a graphical user interface or web-based dashboard for migration tasks

Pros & Cons

Pros

Cross-Repository Flexibility

It transfers issues between any two GitHub repositories, even unrelated or private ones, as highlighted in the README, making it versatile for various migration scenarios.

Metadata Preservation

Imports comments, labels, and milestones, creating them in the target repository if they don't exist, ensuring historical context is maintained during migration.

Configurable Import Options

Supports importing all issues, only open issues, or specific issue numbers via command-line arguments like --open or --issues, offering granular control.

Customizable Templates

Uses editable Markdown templates for issue formatting, allowing users to tailor the appearance and content of imported issues to fit their needs.

Cons

Pull Request Limitations

Pull requests are imported as issues without code diffs or pull request functionality, requiring manual effort to integrate the suggested code, as admitted in the README.

Comment Attribution Issues

All imported comments are attributed to a single account specified in the config, with original authors only mentioned in text headers, losing genuine authorship.

Security Risks with Credentials

The default configuration stores passwords in plain-text files, posing a security vulnerability, though the README warns about this and suggests using command-line arguments.

One-Time Migration Only

It lacks support for ongoing synchronization or updates after import, making it unsuitable for scenarios requiring continuous data flow between repositories.

Frequently Asked Questions

Related Projects

GitHub Cheat Sheet

A list of cool features of Git and GitHub.

Stars57,261

Forks5,422

Last commit2 years ago

Hub

A command-line tool that makes git easier to use with GitHub.

Stars22,951

Forks2,216