How to Configure and Use GitHub with ScrumDo
To get started, here's a short 5 minute overview on the particulars of setting up GitHub for ScrumDo:
Update - Pull Requests
Since making the video above, support for GitHub pull requests has been added. It works nearly identically to the support for GitHub commits. To use it, tag a pull request (or any commit within that pull request) with a ScrumDo card, and the pull request will show up on the Card in ScrumDo.
When configuring the GitHub extra, there are several configuration options you can choose from. Those options are explained below.
Upload ScrumDo Stories as Github issues
This will cause any card that already exists in ScrumDo, or any new card created, to be uploaded to the GitHub repo as a new issue.
After the initial upload, changes will be synchronized between the card and the issue.
Download GitHub issues into the ScrumDo import queue
This will cause any existing, or any newly created GitHub issues to be downloaded into ScrumDo’s import queue, from there you can choose to import them into your ScrumDo project.
After the initial download, changes will be synchronized between the card and the issue.
Synchronize issue status with board cell
For any cards/issues that have been uploaded or downloaded, ScrumDo will attempt to keep the issue status in sync with the cell on the board.
- If a card is moved to a cell set as Done Time, the issue will be closed.
- If a card is deleted, the issue will be closed.
- If a card is moved from a done cell, to a not-done cell, the issue will be re-opened.
- If an issue is closed, the card will be moved to a done cell.
- If an issue is reopened, the card will be moved to the default cell for the board.
Link commits and pull requests to ScrumDo cards
This enables commit message support in ScrumDo.
Available commit message commands
Tag commit or pull request to ScrumDo card
(Card # or Story # or sd-)## Tag a ScrumDo card with a commit message. You can use any of these three message styles. If you use GitHub issues, the last format will allow you to avoid conflicts with the issue auto-tagging format. Examples:
This is my normal commit message. I was working on Card #10
This is my normal commit message. I was working on Story #10
This is my normal commit message. I was working on sd-10
Move ScrumDo card
(Card # or Story # or sd-)## Cell Name Tag a ScrumDo card with a commit message and move it on your board to the specified Cell.
This is my normal commit message. I was working on sd-10 Todo