Back to Flutter Inner Source homepage
inner source

Capability Pull Request Boards

A capability is a collection of repositories that together do something meaningful. Each capability is governed by a group of maintainers. Maintainers therefore require a view of all the changes (“pull requests” in GitHub) across all repositories in a capability. This view is supported by capability pull request boards which can be created for your capability in a few minutes.

Creating a Capability PR Board

To create a board:

  1. Navigate to the existing project list via the ‘Projects’ tab in Flutter-Global.
  2. Use the ‘New Project’ button to launch the create project wizard: choose an appropriate name and make sure the repository is private. There is no need to link any repositories.
  3. In the board description field include the repository name of your capability preceeded by a $. You may include more than one capability or use specific repository names instead. For example a description of “This board tracks $cap-inner-source-documentation $cap-inner-source-automation” will track PRs from all repos in both those capabilities. The board description can be changed at any time.
  4. You can use a -$ prefix to exclude specific repositories from a capability. For example a board description of “Track $cap-inner-source-documentation -$key-technologies” will track PRs from all repositories in cap-inner-source-documentation apart from those from the key-technologies repository.
  5. Once the project is created, use the ‘Add Column’ button to create the columns that you would like to use. For the automation to recognise the columns you need to include one of a set of standard snippets in the column name as in the table below.
  6. Wait for the board to be populated. All boards are updated by a scheduled job, so it may take up to 30 mins for the board to become fully populated will all your capability PRs.
Semantic Meaning Column Name Contains
Early stub PRs that are in a draft state. “To do”, “Draft”, “✏”
PRs that are now ready to review “In progress”, “Open”, “🔍”
PRs that are approved and can be merged “Reviewed”, “Approved”, “👍”
Closed or merged PRs that are complete “Done”, “Closed”, “✅”

If you prefer to use only 3 columns, PRs that are approved and can be merged will be placed in the same column as ready to review PRs if the approved column does not exist.

Understanding the Automated Behaviour

The capability PR boards are populated by automation maintained by the inner source team.

Troubleshooting a Capability PR Board

Here are some simple checks if the board is not behaving as you expect:

Feel free to reach out to the inner source team for any assistance.