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 can trigger it.

Configuration Options

• Name - this identifies the publication inside Doc Holiday. Publication names must be unique.

• Sources - connections that contain information used for generating words

• Targets - repositories that Doc Holiday will write documentation and release notes to

• Sharing and access - open the publication share view from the publication page to manage publication sharing. The publication details view also shows a People With Access area.

• Style and formatting guidance - direction for Doc Holiday to use

• Notifier connection (optional) - select a notifier connection in addition to the source and target connections. When configured, it sends a completion notification after output is ready. Publications currently support Slack-based notifications.

• React to: - define which activity in source and destination repos can trigger Doc Holiday

  • Pull Requests - creating a new pull request with a description containing @doc.holiday, followed by an instructive prompt

  • New Issues - creating a new issue with a description containing @doc.holiday, followed by an instructive prompt

  • Issue Comments - adding a comment to an existing issue containing @doc.holiday, followed by an instructive prompt

  • 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. GitHub Workflow Run events are supported for connected repositories and triggerable via the workflow's unique path or ID.

    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.

• Output options - define what types of writing Doc Holiday should draft

  • Release Notes - will create lists of changes based upon the source repos defined and the relevant issues and pull requests discovered from the triggering activity

  • Documentation - will update existing and create new documentation, as required, based upon the current documentation in the repo and relevant issues and pull requests discovered from the triggering activity

  • Changelog - will create changelog entries based upon the source repos defined and the relevant issues and pull requests discovered from the triggering activity

• 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.