Learn how to use SpecFuse to capture ideas, develop software specifications, and manage your project as you bring your software to life.

GitHub & SpecFuse

When you connect your SpecFuse project with a GitHub repo, you will be able to keep specs and issues in sync, allowing your team to work from either system.


With this integration, you could connect an existing repo and import all your issues to SpecFuse, automatically creating matching specs. From there, you have the full power of SpecFuse to plan, manage, and monitor your project. Once imported, specs will automatically publish changes back to out to GitHub when they are updated.


Another way to use this integration would be to first create specs in SpecFuse, and then connect and publish to issues on a GitHub repo only when you are ready to start development.


Setting up


GitHub

SpecFuses uses a GitHub app to connect to GitHub and interact with your repositories. To get started, you will need to install this GitHub app on a repo in your GitHub account or an organization you have administration rights on.



SpecFuse

Once installed, you can continue setting up the integration in SpecFuse.

  • Click on Admin in the menu.
  • Click on Integrations in the sub-menu.
  • Click on GitHub.
  • If you have not installed the SpecFuse GitHub App, you can do that now.
  • Click on the Authenticate With GitHub link. You will be taken to GitHub to associate your GitHub account with your SpecFuse account.
  • Click on Select a GitHub repo. A list of your repos with the SpecFuse GitHub app will be loaded.
  • Select the repo you wish to integrate with your SpecFuse project and then click Save.
  • Click the Circle Arrows button to open the Setup GitHub Webhook configuration modal.


GitHub - Part 2

  • Open the repo in GitHub.
  • Click on Settings.
  • Click on Webhooks.
  • Click Add Webhook.
  • Copy the Payload URL and Secret from the SpecFuse modal into the matching fields.
  • Select a content type of application/json.
  • Choose Let me select individual events and then select only the Issues option.
  • Check the active option.
  • Click Add Webhook.