diff --git a/.github/workflows/README.md b/.github/workflows/README.md new file mode 100644 index 000000000..3347b05f8 --- /dev/null +++ b/.github/workflows/README.md @@ -0,0 +1,22 @@ +# Llama Stack CI + +Llama Stack uses GitHub Actions for Continous Integration (CI). Below is a table detailing what CI the project includes and the purpose. + +| Name | File | Purpose | +| ---- | ---- | ------- | +| Update Changelog | [changelog.yml](changelog.yml) | Creates PR for updating the CHANGELOG.md | +| Coverage Badge | [coverage-badge.yml](coverage-badge.yml) | Creates PR for updating the code coverage badge | +| Installer CI | [install-script-ci.yml](install-script-ci.yml) | Test the installation script | +| Integration Auth Tests | [integration-auth-tests.yml](integration-auth-tests.yml) | Run the integration test suite with Kubernetes authentication | +| SqlStore Integration Tests | [integration-sql-store-tests.yml](integration-sql-store-tests.yml) | Run the integration test suite with SqlStore | +| Integration Tests | [integration-tests.yml](integration-tests.yml) | Run the integration test suite with Ollama | +| Vector IO Integration Tests | [integration-vector-io-tests.yml](integration-vector-io-tests.yml) | Run the integration test suite with various VectorIO providers | +| Pre-commit | [pre-commit.yml](pre-commit.yml) | Run pre-commit checks | +| Test Llama Stack Build | [providers-build.yml](providers-build.yml) | Test llama stack build | +| Python Package Build Test | [python-build-test.yml](python-build-test.yml) | Test building the llama-stack PyPI project | +| Check semantic PR titles | [semantic-pr.yml](semantic-pr.yml) | Ensure that PR titles follow the conventional commit spec | +| Close stale issues and PRs | [stale_bot.yml](stale_bot.yml) | Run the Stale Bot action | +| Test External Providers Installed via Module | [test-external-provider-module.yml](test-external-provider-module.yml) | Test External Provider installation via Python module | +| Test External API and Providers | [test-external.yml](test-external.yml) | Test the External API and Provider mechanisms | +| Unit Tests | [unit-tests.yml](unit-tests.yml) | Run the unit test suite | +| Update ReadTheDocs | [update-readthedocs.yml](update-readthedocs.yml) | Update the Llama Stack ReadTheDocs site |