Publications

Publications define which sources Doc Holiday will read from, where it will write to, what kinds of content it will write, and what kinds of activity will trigger it.

Configuration Options

• Name - this will serve as an internal reference within Doc Holiday
• Inputs - connections that contain information used for generating words
• Targets - repositories that Doc Holiday will write documentation and release notes to
• React to: - define what type of activity, in both source and destination repos, Doc Holiday should react to
  • Pull Requests - creating a new pull request with a description containing @sandgarden or @doc.holiday, followed by an instructive prompt
  • New Issues - creating a new issue with a description containing @sandgarden or @doc.holiday, followed by an instructive prompt
  • Issue Comments - adding a comment to an existing issue containing @sandgarden or @doc.holiday, followed by an instructive prompt. This currently honors only comments on issues within the source repos.
  • Releases - creating new releases within source repos
  • Workflow Runs - triggering workflow runs in a connected GitHub repository based on the outcome of a specific workflow.
    1. Path to workflow file - specify the workflow path to monitor (e.g., /github/workflows/deploy.yml). You may also specify the workflow trigger (ID) for greater control over automation.
    2. When the workflow completes, Doc Holiday will generate the appropriate content based on configuration.
    • Supported Events: GitHub Workflow Run events are supported for connected repositories and triggerable via the workflow’s unique path or ID.
• Write: - define what types of writing Doc Holiday should draft
  • Release Notes - will create lists of changes based upon the source repos defined and referenced in the triggering activity
  • Documentation - will update existing and create new documentation, as required, based upon the current documentation in the repo
• Style Guide URL (optional, but strongly recommended) - link to a public URL or Google Drive doc for use as a style guide with this specific publication.