ultralytics/docs/help/CI.md

comments	description	keywords
true	Understand all the Continuous Integration (CI) tests for Ultralytics repositories and see their statuses in a clear, concise table.	Ultralytics, CI Tests, Continuous Integration, Docker Deployment, Broken Links, CodeQL, PyPI Publishing

Continuous Integration (CI)

Continuous Integration (CI) is an essential aspect of software development which involves integrating changes and testing them automatically. CI allows us to maintain high-quality code by catching issues early and often in the development process. At Ultralytics, we use various CI tests to ensure the quality and integrity of our codebase.

Here's a brief description of our CI tests:

• CI: This is our primary CI test that involves running unit tests, linting checks, and sometimes more comprehensive tests depending on the repository.
• Docker Deployment: This test checks the deployment of the project using Docker to ensure the Dockerfile and related scripts are working correctly.
• Broken Links: This test scans the codebase for any broken or dead links in our markdown or HTML files.
• CodeQL: CodeQL is a tool from GitHub that performs semantic analysis on our code, helping to find potential security vulnerabilities and maintain high-quality code.
• PyPi Publishing: This test checks if the project can be packaged and published to PyPi without any errors.

Below is the table showing the status of these CI tests for our main repositories:

Repository	CI	Docker Deployment	Broken Links	CodeQL	PyPi and Docs Publishing
yolov3
yolov5
ultralytics
hub
docs

Each badge shows the status of the last run of the corresponding CI test on the main branch of the respective repository. If a test fails, the badge will display a "failing" status, and if it passes, it will display a "passing" status.

If you notice a test failing, it would be a great help if you could report it through a GitHub issue in the respective repository.

Remember, a successful CI test does not mean that everything is perfect. It is always recommended to manually review the code before deployment or merging changes.

Happy coding!