New repository settings
All repositories in
kyma-incubator organizations should be similar in structure, settings, and restrictions. Follow these guidelines to adjust settings of a new repository created in one of these organizations.
NOTE: You have to be an owner of the given organization to create a new repository in it.
Whenever you create a new repository, use the template from the
template-repository. This template contains all necessary configuration files for CODEOWNERS, Kyma stale bot, issue and pull request templates, license, and Code of Conduct.
NOTE: Do not mark the Include all branches checkbox as it will clone all branches from the
template-repositoryto your new repo.
Under the repository name, choose the Settings tab. The Options view opens as the default one in the left menu.
- Scroll down to the Features section and clear these options:
- Restrict editing to users in teams with push access only
Define branch protection rules that include enforcing obligatory review and approval of pull requests (PRs), and define which Prow jobs need to pass successfully before merging PR changes into the
To see these settings, go to Branches in the left menu, under repository Settings:
If you add a new repository in:
kyma-project, you do not need to add a new entry to the Prow
config.yamlfile as the branch protection is already defined for all repositories within this organization. The only exception is if you want to specify additional rules that are not handled by Prow.
kyma-incubator, add a new repository entry to the Prow
config.yamlfile, under branch-protection.orgs.kyma-incubator.repos. See an example of such an entry for the
Ask a kyma-project owner to:
- Add the newly created repository to the Contributor License Agreement (CLA).
- Add the
kyma-botusername to be exempt from signing the CLA.
If you define any governance-related Prow job for the new repository to validate documentation links, you must add a
milv.config.yaml file at the root of the repository. See an example of the milv file.
Track all repository changes that deviate from configuration standard described in the guidelines with an issue.