Setting up a Github Integration

← Back to Github section

If you use Github to manage your development workflow, you can set up a direct integration between ProdPad and Github.

The integration allows you to push ideas or individual user stories to Github, once you've completed fleshing out your product specs in ProdPad.

Getting the integration with Github set up is easy, and just requires you to follow these steps:

Part 1: Install the ProdPad app in Github
Part 2: Setting up and Authorising the Github integration in ProdPad
Part 3: Pushing Ideas to Github
Part 4: Get your team on board

Part 1: Install the ProdPad app in Github

To start you need to add the ProdPad OAuth app to your Github organization - you can find this here - go an install this now and come back when you are done!

Just make sure you pick the right access option for you - either All repositories or Only select repositories, depending on your access/security requirements.

Part 2: Setting up the Github integration in ProdPad

Now go to ProdPad, click on your company name on the top left of the side navigation and then Integrations

From the Gallery tab locate Development integrations, select Github from the list of options.

Name your integration and login to Github to complete the authorization process. 

You will now see a list of all of the projects* within your Github account that you can push ideas to. Select one of the projects by clicking on the name.

*Note: the list will only show 200 projects. Please get in contact if you have more than 200 projects in Github

Next select the project item for ideas and user stories (issue or comment) and map accordingly.

Select which fields from ProdPad you will be sending to each of the fields available to your Github project, as well as the status mapping that will reflect within ProdPad.

Next map the workflow statuses.

We currently map to Github open/closed statuses only.

Click on 'Save Changes' to complete the mapping process.

Your Github integration is now ready to use!

Part 2: Pushing Ideas to Github

Now that you've got an active integration with Github set up, it's time to start pushing finished ideas from ProdPad to Github.

Head to your Ideas List, and pick an idea that's ready for development. In the Idea Canvas page, click on Push to Dev. This will open up a modal window where you can choose to push the Idea via the Github integration you've set up, or any of your other integrations.

You should see the Github integration you just created. 

Once pushed, on the Idea Canvas now, there will be a link to the Github ticket in the 'Links' section, and the ticket in Github will link back to the ProdPad idea.

Part 3: Get your team on board

To make it easy for your team to use the same integration mappings, you can share your integration with your team.

In your Integrations list, toggle the 'Teamwide' on the integration page.