Skip to content

Team names required syntax when used for CODEOWNERS file #32812

@OsirisTerje

Description

@OsirisTerje

Code of Conduct

What article on docs.github.com is affected?

This one about creating a team doesn't state the allowed syntax for a team name: https://docs.github.com/en/organizations/organizing-members-into-teams/creating-a-team
And this page on CODEOWNERS, https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners#codeowners-syntax, doesn't mention it either.

What part(s) of the article would you like to see updated?

A section on syntax for team names should be added.

A team name with '.' included is not allowed in a CODEOWNERS file, resulting in the following error:
image

and the error description points to the characters from the dot to the end.

I would assume that casing of the team name is also critical. There might also be other non-allowed characters besides those mentioned on the CODEOWNERs page.

Additional information

This would affect all organizations that are using team names with dots.

This syntax is correct:
image

Metadata

Metadata

Assignees

No one assigned

    Labels

    code ownersContent related to code ownerscontentThis issue or pull request belongs to the Docs Content teamstaleThere is no recent activity on this issue or pull requestwaiting for reviewIssue/PR is waiting for a writer's review

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions