GitHub

GitHub is the world's leading software development platform. With Scrumpy you're able to connect your GitHub repositories with your Scrumpy projects.

Connect Your Project with GitHub

Scrumpy projects are connected through a Webhook.

  1. Open Scrumpy and go to the project you want to connect.
  2. Open the project settings, click on integrations.
  3. You'll need the webhook URL and the secret token.
  4. Open your GitHub repository and go to Settings > Webhooks.
  5. Add a new webhook with the following settings:
  • Payload URL: Scrumpy Webhook URL
  • Content type: application/json
  • Secret: Scrumpy Secret
  • 👉 Enable SSL verification
  • 👉 Let me select individual events: Pushes and Pull requests
  • ✅ Active

Reference a Story in Your Commit Message

If your repository is connected successfully, you can mark stories as done with your commit messages. Here are a few examples:

working on the feature, see #1

references #1, see #2

work on this nasty bug (ref #42)

You can use other keywords, too. Here is a complete list of all recognized keywords to link your commits to stories:

  • addresses, re, references, ref, refs, see

Mark Stories as Complete

If your repository is connected successfully, you can mark stories as done with your commit messages. Here are a few examples:

adding more cats, fix #1

fix #1, resolve #2

fix this nasty bug (implement #42)

You can use other keywords, too. Here is a complete list of all recognized keywords to mark a story as done:

  • close, closes, closed, closing
  • fix, fixes, fixed, fixing
  • resolve, resolves, resolved, resolving
  • implement, implements, implemented, implementing