https://github.com/phil91/jihub
Command Tool to help exporting Issues from Jira and import them as GitHub Issues
https://github.com/phil91/jihub
dotnetcore exporter github-issues import jira
Last synced: 6 months ago
JSON representation
Command Tool to help exporting Issues from Jira and import them as GitHub Issues
- Host: GitHub
- URL: https://github.com/phil91/jihub
- Owner: Phil91
- License: apache-2.0
- Created: 2023-05-15T19:53:01.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-30T06:26:02.000Z (almost 2 years ago)
- Last Synced: 2024-01-30T10:34:19.290Z (almost 2 years ago)
- Topics: dotnetcore, exporter, github-issues, import, jira
- Language: C#
- Homepage:
- Size: 80.1 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Support: SUPPORT.md
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stars][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![Apache-2.0 License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
jihub
Command Line Tool to help exporting Issues and Attachments from Jira and import them as GitHub Issues
Report Bug
·
Request Feature
Table of Contents
* [About The Project](#about-the-project)
* [Getting Started](#getting-started)
* [Prerequisites](#prerequisites)
* [Setup](#setup)
* [Usage](#usage)
* [Create you Jira search query](#create-you-jira-search-query)
* [Execute Jihub](#execute-jihub)
* [Roadmap](#roadmap)
* [Known Limitations](#known-limitations)
* [Contributing](#contributing)
* [License](#license)
* [Contact](#contact)
## About The Project
`Jihub` is a sophisticated tool designed to streamline the process of importing Jira issues into GitHub based on specific search queries. With `Jihub`, you can seamlessly convert Jira issues into GitHub Issues, ensuring a smooth transition and preserving vital information such as labels, fix versions, and attachments.
Additionally, `Jihub` offers an optional feature to export Jira attachments directly to a designated GitHub repository, further enhancing collaboration and consolidating project resources.
For detailed instructions on how to utilize `Jihub` effectively, please refer to the [Usage](#usage) section. Experience the convenience and efficiency of effortlessly migrating your Jira issues to GitHub with `Jihub`.
## Getting Started
To start using `Jihub`, please follow the steps below.
### Prerequisites
Before executing `Jihub`, make sure you have the following prerequisites:
- A GitHub Personal Access Token (PAT) for authentication.
- Write access to the github repository you want to import the issues to
- Valid login credentials for a publicly accessible Jira instance.
- OPTIONAL: If you want to export the jira attachments you need write access to the repository you want to import the attachments to.
### Setup
To setup `Jihub`, just follow these steps:
1. Download the release package of your choice.
2. Within the package, locate the specific zip file for your operating system. For example, if you're using macOS, select `jihub-osx64.zip`.
3. Alternatively, you can download the latest build artifact from the [Actions](https://github.com/Phil91/jihub/actions) section. On the left side, select the Build action and download the artifact that matches your operating system.
4. Unzip jihub and navigate into the unziped folder.
5. Open the appsettings.json with an editor of your choice and fill the following fields
| Configuration | Key | Value |
|--------------------|----------------------|----------------|
| Jira | JiraInstanceUrl | The url of your jira instance, e.g. https://example-jira.com/ |
| | JiraUser | Your jira username |
| | JiraPassword | Your jira password |
| GitHub | Token | Your generated GitHub PAT |
| Parsers:Jira | EmailMappings | Mapping between JiraEmail and Github Name, should be in the following format: { "JiraMail": "test.mail.com", "GithubName": "Phil91" } |
| Parsers:Jira | DescriptionTemplate | Template for the Github description. Valid values currently: Description, Components, Sprints, FixVersions, StoryPoints, Attachments please make sure that those values are listed within {{}} |
By following these steps, you'll be able to use `Jihub` for importing Jira issues to GitHub.
## Usage
### Create you Jira search query
In your Jira Instance, navigate to `/issues`, for example: https://your-jira-instance.com/issues.
You can filter for the issues of your needs. After your search result is as wanted, click the Advanced Link right next to the serach button to be able to see your jql query. Copy the query and URL encode it (there are plenty of sites doing it on the fly online).
### Execute Jihub
Once you completed the setup open a terminal and navigate to your jihub folder. To run the import simply run:
```shell
dotnet jihub.Worker.dll
```
| Parameter | Short Name | Long Name | Required | Default | Description |
|--------------------|------------|-----------------|----------|---------|--------------------------------------------------------------------------------------------|
| Repo | -r | --repo | Yes | | Name of the GitHub repository |
| Owner | -o | --owner | Yes | | Username of the GitHub user or organization that hosts the project |
| SearchQuery | -q | --query | Yes | | The search query to filter Jira issues, must be url encoded |
| MaxResults | -m | --max-results | No | 1000 | The maximum number of Jira results to retrieve |
| Link | -l | --link | No | false | If set, all external resources such as images will be referred to as a link in the description |
| ContentLink | -c | --content-link | No | false | If set, all external resources such as images will be linked as content in the description |
| Export | -e | --export | No | false | If set, all external resources such as images will be exported to the given repository |
| UploadRepo | -u | --upload-repo | No | | The repository where the Jira assets will be uploaded |
| ImportOwner | -i | --import-owner | No | | The owner of the repository where the Jira assets should be uploaded |
| ImportPath | -p | --import-path | No | | The path of the directory where the Jira assets should be uploaded |
Please note that the "Required" column indicates whether a parameter is mandatory or not, and the "Default" column shows the default value if not specified.
## Roadmap
- [ ] Export to various providers
- [ ] Make configuration easier
- [ ] Enhance Logging
- [ ] Make fields to export to github issues configurable
See the [open issues](https://github.com/phil91/jihub/issues) for a full list of proposed features (and known issues).
## Known Limitations
Due to GitHub Api limitations the import of the issues to GitHub will pause for 20 seconds after 10 created issues before continuing with the next 10.
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
For further information on how to contribute, take a look at [Contributing](https://www.github.com/phil91/jihub/CONTRIBUTING.md)
## License
Distributed under the Apache-2.0 License. See [LICENSE](https://www.github.com/phil91/jihub/LICENSE) for more information.
## Contact
Feel free to always open a dicussion, or hit me up on LinkedIn
Project Link: [https://github.com/phil91/jihub](https://github.com/phil91/jihub)
[contributors-shield]: https://img.shields.io/github/contributors/phil91/jihub.svg?style=for-the-badge
[contributors-url]: https://github.com/phil91/jihub/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/phil91/jihub.svg?style=for-the-badge
[forks-url]: https://github.com/phil91/jihub/network/members
[stars-shield]: https://img.shields.io/github/stars/phil91/jihub.svg?style=for-the-badge
[stars-url]: https://github.com/phil91/jihub/stargazers
[issues-shield]: https://img.shields.io/github/issues/phil91/jihub.svg?style=for-the-badge
[issues-url]: https://github.com/phil91/jihub/issues
[license-shield]: https://img.shields.io/github/license/phil91/jihub.svg?style=for-the-badge
[license-url]: https://github.com/phil91/jihub/blob/master/LICENSE
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/phils91