For the complete documentation index, see llms.txt. This page is also available as Markdown.

Author

Authors are the people or bots that can be attributed different kinds of work items (commits, pull requests, reviews). Authors can be linked to multiple identities across different systems (GitHub, Slack, Jira, etc.).

Properties

ID

id - uuid

ID of the author.

Name

name - text | null

Name of the author, resolved from their linked Swarmia user or, failing that, from their identities in connected integrations. Null when none of them carry a name or a username.

Email

email - text | null

Preferred work email of the author, resolved from their identities using the organization work email domain preferences.

Is bot

isBot - boolean

Whether this author is marked as a bot.

Is current GitHub member

isCurrentGitHubMember - boolean

Whether this author is currently a member of one or more GitHub organizations associated with this Swarmia organization.

Timestamp

timestamp - timestamp

Time when this author was first seen by Swarmia in any of the connected integrations.

Included in Capex report

includeInCapexReport - boolean

Whether this author is included in the organization’s Capex report. All non-bot authors are included by default, and can be manually excluded or re-included.

FTE allocation

fteAllocation - double | null

FTE measures developer effort. By default, each developer gets 1 FTE per month, distributed across projects based on related commits, activity on PRs, and completed issues. 0 means the person doesn’t work as a developer. Null for bots, which are excluded from FTE.

Relations

Member of teams

memberOfTeams - Team (1-N)

Teams this author is a member of.

Team memberships

teamMemberships - Team membership (1-N)

Team membership periods for this author, including inherited memberships through the team hierarchy.

Assigned issues

assignedIssues - Issue (1-N)

Issues this author is currently assigned to.

Pull requests

pullRequests - Pull request (1-N)

Pull requests created by this author.

Attribute values

attributeValues - Author attribute value (1-N) - Beta

Attribute values this author holds.

This page is automatically generated

Last updated

Was this helpful?