GitHub Integration

Setting up and using the GitHub integration

Updated over a week ago

Here's how the GitHub integration works: you connect repositories to Steady with a webhook, and Steady will match up commits and pull request updates to your team members. The events will appear on the activity page and alongside their check-ins.

To use it, visit the settings for a GitHub repository or organization (if you have a lot of repos) you want to connect on GitHub, and click through to the "Webhooks" page. Visit the Account Management - Integrations page in Steady, and copy over the payload URL listed there under the GitHub panel.

In GitHub, select application/json for "Content type", enable SSL verification, and select the Push and Pull Request events.

To test it out, make a push to the GitHub repo and look for a new entry in the activity stream.

Right now, we just process push and pull request events, but if you think other events would be helpful, please let us know!

Here's how the commits in a push event will show up next to check-ins:


You can add as many repos as you want to your Steady team using the same webhook URL.

Auto-complete

Once a few activities have been logged, you can use the auto-complete functionality in check-ins and comments to auto-link to issues in your GitHub repo.

Simply type # and a string of text that is part of your GitHub item and you'll be able to select and auto-insert a fully formatted link to it.

Troubleshooting

  • Look for commits on the Activity page first. The check-ins on the dashboard will sum up commits from the previous period. (The check-ins essentially say "here's what I did yesterday, and here are all the commits to go along with that.)

  • Check to make sure the email address that is being used in GitHub matches the email address that is being used in Steady. If you or a team member is using a different email address in GitHub, set the secondary email address in Steady to match the one used in GitHub.

  • If you're seeing activity for commits, but not for PRs, you may also need to edit your Steady username to match your GitHub username.

  • Make sure that the commit authors (not the person who "pushed" to the repo) match up either by email or by first and last name with people on your team in Steady.

  • The commits have timestamps that are different from when they are pushed to the repo, and we use the commit timestamps to match up with check-ins. So if you pushed commits that are a few days old to a repo, they will appear with older check-ins, or discarded if they happened before you created your Steady account or added the author as a Steady team member.

Did this answer your question?