CI/CD Integrations
Overview
Doc Holiday offers pre-authored CI/CD integrations for easy inclusion in release pipelines. They exist as GitHub Actions and GitLab CI/CD catalob jobs. Each integration invokes Doc Holiday to analyze code changes and related context, then create or update documentation and release notes through the same Jobs API described in the API documentation.
These jobs also enable additional information to be passed to Doc Holiday, including external product sources like JIRA and Linear. This means Doc Holiday will automatically enrich documentation with product specifications from issue trackers and knowledge bases, and describe end user and buyer benefits.
The GitHub Action and GitLab CI/CD job are suited for teams that:
- Run standard GitHub Actions or GitLab pipelines for merges, tags, and releases
- Store product information outside of the code repository (e.g. in Linear)
- Prefer to keep Doc Holiday orchestration inside existing CI/CD configuration
- Want Doc Holiday to automatically generate documentation and release notes based on commits, releases, and tags without authoring separate automation
How the CI/CD integrations work with Doc Holiday
- A GitHub or GitLab pipeline runs for a commit, merge, or release.
- The pipeline job invokes Doc Holiday using the Jobs API, passing information about commits, tags, and relevant context.
- Doc Holiday analyzes the specified changes and connected content sources.
- Doc Holiday writes or updates documentation and release notes for the publications associated with the source connection.
The integrations align with the existing Jobs API behavior for selecting commits by time ranges, tags, releases, or explicit commit lists as described in the API reference.