Our Github integration lets you create and link Github issues from your Harvestr Discoveries. You can then follow the evolution of these issues and their status in GitHub without leaving Harvestr.
Prerequisites
To use our GitHub integration, all you need is:
a GitHub account with one of the following permissions: "Admin," "Owner," "Maintainer," or "Member."
a Harvestr subscription to our Scale plan
a Harvestr account with Editor rights
How to integrate Harvestr into your company's Github account
Connecting your Github account to Harvestr is super simple:
go to your Harvestr settings -> integrations -> Github
click on "Connect to GitHub"
in the OAuth window that pops up, log in to your GitHub account
authorize Harvestr and grant us the rights that are listed
Once this is done, you will be automatically redirected to your Github integration settings in Harvestr and you should now see the option "Remove Github integration".
How to use the Github integration in Harvestr
Now that the integration is set up, a Github section will appear in every Discovery in Harvestr.
You will now be able to :
create and link one or more new GitHub issues to a Discovery
link one or more existing Github issues to a Discovery
1. Create and link one or more new GitHub issues to a Discovery
Once you have decided to launch a Discovery to production, you can create issues in GitHub that correspond to what needs to be developed.
When you press "Create issue" in a Discovery in Harvestr, a window pops up where you can enter the attributes of the issue you want to create, namely its project, its type, its status, one assignee, a summary, and a description.
Once the issue is opened, it will be created in GitHub with the attributes you have entered and an additional link to the Discovery in Harvestr. This gives your software team access to the valuable content in your Discovery, such as user feedback.
In your Discovery in Harvestr, you will also have the link to the newly created issue, and you can keep track of its status evolution in Github.
2. Link one or more existing Github issues to a Discovery
Sometimes, you will also want to link Github issues that already exist to a Harvestr Discovery.
You can do that by clicking the "Link issue" button in your Discovery. This will open a search bar where you will be able to search a Github issue by its name or by its key. The search by key only works when you type the entire key in the search bar.
3. Track GitHub issues' progress from Harvestr
Once you have linked the issue to your Discovery, you can follow its status evolution from the linked Discovery.
You can view issue statuses from your Discoveries table by displaying the GitHub issues field.
You can also filter Discoveries based on the properties of linked GitHub issues to track development work easily.
FAQ & Troubleshooting
I do not see my GitHub organization in the list when linking a GitHub issue to a Harvestr Discovery.
For the Github user who set up the Harvestr integration, you need to set the missing Github organization as public at the user level in Github. The Organization will appear in the list when linking new or existing Github issues to your Discoveries in Harvestr.
If you have requests or ideas about how we could improve our Github integration to better suit your workflow, send us a message!