This document outlines the things to lookout for before merging any PRs to this index
- Ensure that the sender of the PR has not been blacklisted
- The PR must only modify the cccp index.yml file, unless it is from the maintainers of the index.
- The PR must come from a maintainer of a project looking out to be on the index or someone authorized / trusted by the maintainer(s) of the project such as having their PRs getting merged upstream.
- The project must be ready to have their code be visible, and must be legally distributable in the US.
- The change must not destroy existing entries in the index which are not of concern to the requester of the PR.
- A cccp.yml file must be present, and should have appropriate entries in it, especially the job id, which should match across, the index and cccp.yml.
- The entries in the cccp.yml and the index must be properly formatted and checked for errors, such as
- mismatched job-id
- mismatched git-url, git-branch and git-path.
- Listed scripts such as test scripts being non-existent.
- You may use https://github.com/CentOS/container-pipeline-service/tree/master/testindex, to validate the index entries. just run
$ python __init__.py -h
to know what to do
Even if a PR passed, please ensure you read through the logs and the warnings, if any and request that changes be made accordingly. Unless there is an explicit reason why a warning is being ignored, you will be held accountable for merging the PR. along with the sender.
- Inform the sender of the PR about the exact errors.
- Give the sender enough time to act on these comments before closing the PR.