The process of monitoring a code repoository involves some initial setup:
-
(Docs) Create GitHub team in appropriate organization. The team must be in the same organization as the code repository.
- In order to create a team, you must be a member of the org. In order to add someone to a team, they must be members of the org.
- Join an org at
https://repos.opensurce.microsoft.com/orgs/{ORG-NAME}. (For example, https://repos.opensource.microsoft.com/orgs/azure) - Create a team at
https://github.com/orgs/{ORG-NAME}/teams/. (For example, https://github.com/orgs/azure/teams/) - Add members to the team once they've joined the org.
-
(Docs) Add information about the repo to config.yml
-
(Code repository admin) To configure a code repository:
- Add the above GH team with write permissions into the repository.
- Create a CODEOWNERS file in the repository.
- Require approval from a code owner before the author can merge a pull request. Require a reapproval if subsequent pushes made.
Once the repo is configured, a team member is responsible for the maintenance task. (We rotate on a monthly basis for AI Platform Docs.)
- (Daily) Monitor and approve PRs.
- Use
find-prs.pyto find them. - Use
pr-report.pyto check for problems. - Fix any problems as needed before approval. (See Fix the problem).
- Use
- (Weekly) Keep CODEOWNERS file(s) up to date with
find-snippets.py. - (Weekly) Update docs for recent code changes with
merge-report.py
See Maintain code snippets in Azure docs Daily and Weekly tasks for more details.
Code samples we monitor are currently in one of these three repos: