ci.yml and docker.yml rename (#18671)
Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
This commit is contained in:
parent
a7f72d3f69
commit
24f4721d9d
13 changed files with 29 additions and 29 deletions
|
|
@ -12,8 +12,8 @@ Continuous Integration (CI) is an essential aspect of software development which
|
|||
|
||||
Here's a brief description of our CI actions:
|
||||
|
||||
- **[CI](https://github.com/ultralytics/ultralytics/actions/workflows/ci.yaml):** This is our primary CI test that involves running unit tests, linting checks, and sometimes more comprehensive tests depending on the repository.
|
||||
- **[Docker Deployment](https://github.com/ultralytics/ultralytics/actions/workflows/docker.yaml):** This test checks the deployment of the project using Docker to ensure the Dockerfile and related scripts are working correctly.
|
||||
- **[CI](https://github.com/ultralytics/ultralytics/actions/workflows/ci.yml):** This is our primary CI test that involves running unit tests, linting checks, and sometimes more comprehensive tests depending on the repository.
|
||||
- **[Docker Deployment](https://github.com/ultralytics/ultralytics/actions/workflows/docker.yml):** This test checks the deployment of the project using Docker to ensure the Dockerfile and related scripts are working correctly.
|
||||
- **[Broken Links](https://github.com/ultralytics/ultralytics/actions/workflows/links.yml):** This test scans the codebase for any broken or dead links in our markdown or HTML files.
|
||||
- **[CodeQL](https://github.com/ultralytics/ultralytics/actions/workflows/codeql.yaml):** 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](https://github.com/ultralytics/ultralytics/actions/workflows/publish.yml):** This test checks if the project can be packaged and published to PyPi without any errors.
|
||||
|
|
@ -22,18 +22,18 @@ Here's a brief description of our CI actions:
|
|||
|
||||
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](https://github.com/ultralytics/yolov3) | [](https://github.com/ultralytics/yolov3/actions/workflows/ci-testing.yml) | [](https://github.com/ultralytics/yolov3/actions/workflows/docker.yml) | [](https://github.com/ultralytics/yolov3/actions/workflows/links.yml) | [](https://github.com/ultralytics/yolov3/actions/workflows/github-code-scanning/codeql) | |
|
||||
| [yolov5](https://github.com/ultralytics/yolov5) | [](https://github.com/ultralytics/yolov5/actions/workflows/ci-testing.yml) | [](https://github.com/ultralytics/yolov5/actions/workflows/docker.yml) | [](https://github.com/ultralytics/yolov5/actions/workflows/links.yml) | [](https://github.com/ultralytics/yolov5/actions/workflows/github-code-scanning/codeql) | |
|
||||
| [ultralytics](https://github.com/ultralytics/ultralytics) | [](https://github.com/ultralytics/ultralytics/actions/workflows/ci.yaml) | [](https://github.com/ultralytics/ultralytics/actions/workflows/docker.yaml) | [](https://github.com/ultralytics/ultralytics/actions/workflows/links.yml) | [](https://github.com/ultralytics/ultralytics/actions/workflows/github-code-scanning/codeql) | [](https://github.com/ultralytics/ultralytics/actions/workflows/publish.yml) |
|
||||
| [hub-sdk](https://github.com/ultralytics/hub-sdk) | [](https://github.com/ultralytics/hub-sdk/actions/workflows/ci.yml) | | [](https://github.com/ultralytics/hub-sdk/actions/workflows/links.yml) | [](https://github.com/ultralytics/hub-sdk/actions/workflows/github-code-scanning/codeql) | [](https://github.com/ultralytics/hub-sdk/actions/workflows/publish.yml) |
|
||||
| [hub](https://github.com/ultralytics/hub) | [](https://github.com/ultralytics/hub/actions/workflows/ci.yaml) | | [](https://github.com/ultralytics/hub/actions/workflows/links.yml) | | |
|
||||
| [mkdocs](https://github.com/ultralytics/mkdocs) | [](https://github.com/ultralytics/mkdocs/actions/workflows/format.yml) | | | [](https://github.com/ultralytics/mkdocs/actions/workflows/github-code-scanning/codeql) | [](https://github.com/ultralytics/mkdocs/actions/workflows/publish.yml) |
|
||||
| [thop](https://github.com/ultralytics/thop) | [](https://github.com/ultralytics/thop/actions/workflows/format.yml) | | | [](https://github.com/ultralytics/thop/actions/workflows/github-code-scanning/codeql) | [](https://github.com/ultralytics/mkdocs/actions/workflows/publish.yml) |
|
||||
| [actions](https://github.com/ultralytics/mkdocs) | [](https://github.com/ultralytics/actions/actions/workflows/format.yml) | | | [](https://github.com/ultralytics/actions/actions/workflows/github-code-scanning/codeql) | [](https://github.com/ultralytics/actions/actions/workflows/publish.yml) |
|
||||
| [docs](https://github.com/ultralytics/docs) | [](https://github.com/ultralytics/docs/actions/workflows/format.yml) | | [](https://github.com/ultralytics/docs/actions/workflows/links.yml)[](https://github.com/ultralytics/docs/actions/workflows/check_domains.yml) | | [](https://github.com/ultralytics/docs/actions/workflows/pages/pages-build-deployment) |
|
||||
| [handbook](https://github.com/ultralytics/handbook) | [](https://github.com/ultralytics/handbook/actions/workflows/format.yml) | | [](https://github.com/ultralytics/handbook/actions/workflows/links.yml) | | [](https://github.com/ultralytics/handbook/actions/workflows/pages/pages-build-deployment) |
|
||||
| Repository | CI | Docker Deployment | Broken Links | CodeQL | PyPI and Docs Publishing |
|
||||
| --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| [yolov3](https://github.com/ultralytics/yolov3) | [](https://github.com/ultralytics/yolov3/actions/workflows/ci-testing.yml) | [](https://github.com/ultralytics/yolov3/actions/workflows/docker.yml) | [](https://github.com/ultralytics/yolov3/actions/workflows/links.yml) | [](https://github.com/ultralytics/yolov3/actions/workflows/github-code-scanning/codeql) | |
|
||||
| [yolov5](https://github.com/ultralytics/yolov5) | [](https://github.com/ultralytics/yolov5/actions/workflows/ci-testing.yml) | [](https://github.com/ultralytics/yolov5/actions/workflows/docker.yml) | [](https://github.com/ultralytics/yolov5/actions/workflows/links.yml) | [](https://github.com/ultralytics/yolov5/actions/workflows/github-code-scanning/codeql) | |
|
||||
| [ultralytics](https://github.com/ultralytics/ultralytics) | [](https://github.com/ultralytics/ultralytics/actions/workflows/ci.yml) | [](https://github.com/ultralytics/ultralytics/actions/workflows/docker.yml) | [](https://github.com/ultralytics/ultralytics/actions/workflows/links.yml) | [](https://github.com/ultralytics/ultralytics/actions/workflows/github-code-scanning/codeql) | [](https://github.com/ultralytics/ultralytics/actions/workflows/publish.yml) |
|
||||
| [hub-sdk](https://github.com/ultralytics/hub-sdk) | [](https://github.com/ultralytics/hub-sdk/actions/workflows/ci.yml) | | [](https://github.com/ultralytics/hub-sdk/actions/workflows/links.yml) | [](https://github.com/ultralytics/hub-sdk/actions/workflows/github-code-scanning/codeql) | [](https://github.com/ultralytics/hub-sdk/actions/workflows/publish.yml) |
|
||||
| [hub](https://github.com/ultralytics/hub) | [](https://github.com/ultralytics/hub/actions/workflows/ci.yml) | | [](https://github.com/ultralytics/hub/actions/workflows/links.yml) | | |
|
||||
| [mkdocs](https://github.com/ultralytics/mkdocs) | [](https://github.com/ultralytics/mkdocs/actions/workflows/format.yml) | | | [](https://github.com/ultralytics/mkdocs/actions/workflows/github-code-scanning/codeql) | [](https://github.com/ultralytics/mkdocs/actions/workflows/publish.yml) |
|
||||
| [thop](https://github.com/ultralytics/thop) | [](https://github.com/ultralytics/thop/actions/workflows/format.yml) | | | [](https://github.com/ultralytics/thop/actions/workflows/github-code-scanning/codeql) | [](https://github.com/ultralytics/mkdocs/actions/workflows/publish.yml) |
|
||||
| [actions](https://github.com/ultralytics/mkdocs) | [](https://github.com/ultralytics/actions/actions/workflows/format.yml) | | | [](https://github.com/ultralytics/actions/actions/workflows/github-code-scanning/codeql) | [](https://github.com/ultralytics/actions/actions/workflows/publish.yml) |
|
||||
| [docs](https://github.com/ultralytics/docs) | [](https://github.com/ultralytics/docs/actions/workflows/format.yml) | | [](https://github.com/ultralytics/docs/actions/workflows/links.yml)[](https://github.com/ultralytics/docs/actions/workflows/check_domains.yml) | | [](https://github.com/ultralytics/docs/actions/workflows/pages/pages-build-deployment) |
|
||||
| [handbook](https://github.com/ultralytics/handbook) | [](https://github.com/ultralytics/handbook/actions/workflows/format.yml) | | [](https://github.com/ultralytics/handbook/actions/workflows/links.yml) | | [](https://github.com/ultralytics/handbook/actions/workflows/pages/pages-build-deployment) |
|
||||
|
||||
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.
|
||||
|
||||
|
|
@ -69,7 +69,7 @@ In the sunburst graphic below, the innermost circle is the entire project, movin
|
|||
|
||||
### What is Continuous Integration (CI) in Ultralytics?
|
||||
|
||||
Continuous Integration (CI) in Ultralytics involves automatically integrating and testing code changes to ensure high-quality standards. Our CI setup includes running [unit tests, linting checks, and comprehensive tests](https://github.com/ultralytics/ultralytics/actions/workflows/ci.yaml). Additionally, we perform [Docker deployment](https://github.com/ultralytics/ultralytics/actions/workflows/docker.yaml), [broken link checks](https://github.com/ultralytics/ultralytics/actions/workflows/links.yml), [CodeQL analysis](https://github.com/ultralytics/ultralytics/actions/workflows/codeql.yaml) for security vulnerabilities, and [PyPI publishing](https://github.com/ultralytics/ultralytics/actions/workflows/publish.yml) to package and distribute our software.
|
||||
Continuous Integration (CI) in Ultralytics involves automatically integrating and testing code changes to ensure high-quality standards. Our CI setup includes running [unit tests, linting checks, and comprehensive tests](https://github.com/ultralytics/ultralytics/actions/workflows/ci.yml). Additionally, we perform [Docker deployment](https://github.com/ultralytics/ultralytics/actions/workflows/docker.yml), [broken link checks](https://github.com/ultralytics/ultralytics/actions/workflows/links.yml), [CodeQL analysis](https://github.com/ultralytics/ultralytics/actions/workflows/codeql.yaml) for security vulnerabilities, and [PyPI publishing](https://github.com/ultralytics/ultralytics/actions/workflows/publish.yml) to package and distribute our software.
|
||||
|
||||
### How does Ultralytics check for broken links in documentation and code?
|
||||
|
||||
|
|
@ -81,7 +81,7 @@ Ultralytics uses a specific CI action to [check for broken links](https://github
|
|||
|
||||
### How does Ultralytics utilize Docker for deployment?
|
||||
|
||||
Ultralytics employs Docker to validate the deployment of our projects through a dedicated CI action. This process ensures that our [Dockerfile and associated scripts](https://github.com/ultralytics/ultralytics/actions/workflows/docker.yaml) are functioning correctly, allowing for consistent and reproducible deployment environments which are critical for scalable and reliable AI solutions.
|
||||
Ultralytics employs Docker to validate the deployment of our projects through a dedicated CI action. This process ensures that our [Dockerfile and associated scripts](https://github.com/ultralytics/ultralytics/actions/workflows/docker.yml) are functioning correctly, allowing for consistent and reproducible deployment environments which are critical for scalable and reliable AI solutions.
|
||||
|
||||
### What is the role of automated PyPI publishing in Ultralytics?
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue