diff --git a/README.md b/README.md index 6a00790..ef6eca8 100644 --- a/README.md +++ b/README.md @@ -5,10 +5,11 @@

+ Latest release + GHCR package Enterprise CI Security and supply chain Release validation - Latest release MIT license Last commit

@@ -180,6 +181,17 @@ Run the Streamlit demo locally: streamlit run streamlit_app.py ``` +### Run the published container + +Tagged releases publish the validated image to GitHub Container Registry. After the release workflow succeeds, pull the matching version and run the API: + +```bash +docker pull ghcr.io/coreyleath-code/helixagent:1.1.0 +docker run --rm -p 8000:8000 ghcr.io/coreyleath-code/helixagent:1.1.0 +``` + +Then verify it with `curl http://localhost:8000/health`. + For an isolated package-build check, use the release gate's packaging path: ```bash @@ -205,15 +217,14 @@ docker run --rm -p 8000:8000 helixagent ## Releases and reproducibility Maintainers create releases by pushing a validated semantic-version tag; the tag workflow -validates the exact commit before it can create a GitHub Release. +validates the exact commit before it can create a GitHub Release and then publishes the validated GHCR image. ~~~bash git tag -a vX.Y.Z -m "vX.Y.Z" git push origin vX.Y.Z ~~~ -See [release procedure and evidence artifacts](docs/RELEASING.md) for the required -changelog/version update, validation, and reproducibility guidance. +Release artifacts include the deterministic source archive, SHA-256 checksum, CycloneDX SBOM, and reproduction instructions. See [release procedure and evidence artifacts](docs/RELEASING.md) for the required changelog/version update, validation, and reproducibility guidance. ### Reproduce an evidence run @@ -287,4 +298,4 @@ docs/ Engineering and deployment notes HelixAgent is an engineering portfolio project and reference implementation, not a managed commercial AI platform. The repository focuses on modularity, graceful degradation, observable services, automated validation, and secure delivery. -See [Autonomous runtime](docs/AUTONOMY.md), [Security](SECURITY.md), [Contributing](CONTRIBUTING.md), [Changelog](CHANGELOG.md), and [deployment hygiene](docs/L6_DEPLOYMENT_HYGIENE.md). +See [Autonomous runtime](docs/AUTONOMY.md), [Security](SECURITY.md), [Contributing](CONTRIBUTING.md), [Changelog](CHANGELOG.md), and [deployment hygiene](docs/L6_DEPLOYMENT_HYGIENE.md). \ No newline at end of file