GitHub Integration

Link Canny posts with GitHub issues and update posts on issue close

Daniel Murray avatar
Written by Daniel Murray
Updated over a week ago

Link Canny posts with GitHub issues to keep the two platforms in sync and notify users when a post has been completed!


Link Canny posts with GitHub issues

After successfully installing GitHub, you should see a new section in the post sidebar and in the roadmapping/prioritization tool:

Start typing in the name of the issue and Canny will search GitHub and provide suggestions. Select the issue you'd like to link and you're done!

NOTE: Only OPEN GitHub issues can be linked. If the issue is closed, you'll need to reopen it in order to link it to Canny!

You should now be able to click on the link in Canny to view the issue in GitHub. The Canny bot leaves a comment in GitHub with a link back to the Canny post.


Rules for Status Updates

When setting up your GitHub integration, you have the option to set up status change rules. When a rule is created, the status of a Canny issue can be automatically be updated if there are changes to a GitHub issue.


How to install

To get started, go to your GitHub settings page and click the "Install GitHub" button:

Follow along below:

Step-by-step

  1. From the GitHub settings page click on Install GitHub:

2. You will then be routed to GitHub where you will be prompted to install our GitHub App.

Select where you want to install Canny. Choose the profile or organization with the GitHub issues you'll be linking to Canny.

You can choose all repositories or select only the repositories that have issues you'd like to link to.

Finally, you will be rerouted back to Canny to complete the installation process. Simply select the company you'd like to integrate with GitHub.
​

You can then configure what happens to your linked Canny posts when issues are closed in GitHub.
​



How to Uninstall

If you would like to uninstall the Canny integration from Github, it must be done through the Github application configuration.

Just head to the Installations page in GitHub:

Follow along below:

Step-by-step

1. Start by opening your organization settings from the profile dropdown. Your Organizations > Settings

2. From your settings, navigate through Github Apps > Canny > Configure

3. Finally, you can find the Uninstall button to disconnect Canny from Github.

As always, just reach out if you have any questions! We are here to help! πŸ‘


Related Articles:

Did this answer your question?