Waffle provides lightweight project management for GitHub.  This help article provides an overview of how Waffle works with GitHub.

Overview
Waffle makes it easy to see all of your GitHub activity organized into projects even across multiple repositories.  All of the information you see in Waffle - issues, pull requests, epics, dependencies, labels - are stored in GitHub.  Waffle organizes this information into Waffle boards which are automatically updated based on activity in GitHub.  

Waffle lets you work how and where you want.  You can work in git, GitHub, or Waffle. Changes are saved in GitHub and updated in real-time in Waffle.

GitHub Repositories
Waffle is organized by projects.  You can create one or more projects in Waffle.  Each project is associated with one or more repositories in GitHub.  While a repository can be part of multiple projects in Waffle, a repository can only be the main repository in a single Waffle project. 

Each Waffle project has a Waffle board, a visual way to track the status of open GitHub issues and pull requests from the repositories connected to a Waffle board.

GitHub Branches
Waffle can automatically move a card into the Work Started column (In Progress column by default) on a Waffle board when creating a branch.

GitHub Issues and Pull Requests
A Waffle board displays cards for open GitHub issues and pull requests from the repositories connected to a Waffle board.  Waffle also lets you archive closed issues and pull requests, which can still be viewed in Waffle or GitHub.

Waffle also provides the ability to visually connect GitHub issues and pull requests on a Waffle board as a single card which moves across the board together.  This is especially helpful when multiple pull requests across multiple repositories are needed to resolve a single issue.  

Waffle can automatically move a card into the Code Review or Done column on a Waffle board when creating or merging a Pull Request.

GitHub Pull Request Status, Reviews, and Checks
Waffle boards automatically display the real-time status of GitHub pull requests (ex. merged), pull request reviews (ex. approved), and status checks (ex. automated tests).

Permissions and Authorization
To use Waffle, you must authorize Waffle to access your GitHub organizations and repositories.  Your ability to view, add, and update GitHub issues and pull requests from a Waffle board is based on your permissions with the corresponding GitHub repositories.

Additionally, to use WaffleBot to automatically keep your Waffle boards up to date, a repository's or organization's administrator must authorize WaffleBot to access each repository or organization. 


Did this answer your question?