GitHub Projects Support

GitHub Projects is GitHub's flexible and configurable planning and task management system. Logilica supports GitHub Projects boards by importing them as Planning data.

Given the highly customisable nature of GitHub Projects, Logilica uses a number of heuristics and rules to map and model planning data from GitHub Projects.

These rules are based on matching either labels on GitHub Issues, or on a custom field within an issue. The values of these fields or labels are then mapped into the Logilica data model. Unless stated otherwise, all matching is done case-insensitively.

Issue Types

GitHub Project Issue types are detected in two ways:

A label on the issue that begins with kind/ or type/ the text following the / is taken as the issue type name.
The value of a custom field named either kind or type is taken as the issue type name.

Note: when both these are present, the custom field takes precedence

Issue Status

Logilica matches against GitHub's issue status field and maps this internally to one of three states

Todo - any item whose issue state is unset or matches todo or to do
In Progress - any item whose issue state matches in progress or in review
Done - any item whose issue state matches done

Sprints

Logilica detects Sprints through the values used in a custom iteration field within imported issues. The custom iteration field must be named sprint.

Other Fields

In addition to the above, the below fields are also supported:

Priority - matches the value that appears after a label that starts with priority/ or a custom field on an issue with the name priority.
Story Points - matches on a custom field within an issue named story point

Best Practices

For Logilica to most accurately reflect the GitHub Projects data, we recommend following a few best practices in your GitHub Projects setup:

Use labels or custom fields to define issue types with the convention explained above.
Use issue status such as todo , in progress and done as explained above.
Make sure you are using the iteration field to define sprints.
Define story points and priorities as described above.

For more questions consult the GitHub Projects documentation or connect with your Logilica support representative.

PreviousIntegrations: Data Mapping NextSSO Integration

Last updated 10 months ago

Best Practices

For Logilica to most accurately reflect the GitHub Projects data, we recommend following a few best practices in your GitHub Projects setup:

Use labels or custom fields to define issue types with the convention explained above.

Use issue status such as todo , in progress and done as explained above.

Make sure you are using the iteration field to define sprints.

Define story points and priorities as described above.

For more questions consult the GitHub Projects documentation or connect with your Logilica support representative.