Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Team names required syntax when used for CODEOWNERS file #32812

Open
1 task done
OsirisTerje opened this issue May 6, 2024 · 2 comments
Open
1 task done

Team names required syntax when used for CODEOWNERS file #32812

OsirisTerje opened this issue May 6, 2024 · 2 comments
Labels
code owners Content related to code owners content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review

Comments

@OsirisTerje
Copy link

OsirisTerje commented May 6, 2024

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

@OsirisTerje OsirisTerje added the content This issue or pull request belongs to the Docs Content team label May 6, 2024
Copy link

welcome bot commented May 6, 2024

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label May 6, 2024
@nguyenalex836 nguyenalex836 added code owners Content related to code owners waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels May 6, 2024
@nguyenalex836
Copy link
Contributor

@OsirisTerje Thank you for opening this issue! I'll get this triaged for review ✨

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code owners Content related to code owners content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

No branches or pull requests

3 participants
@OsirisTerje @nguyenalex836 and others