Skip to content

RELEASE.md

Latest commit

 

History

History
40 lines (26 loc) · 995 Bytes

RELEASE.md

File metadata and controls

40 lines (26 loc) · 995 Bytes

Release process

This document is intended for doc2go maintainers only.

Prerequisites

The following must be installed for a new release:

Steps

To release a new version of doc2go, take the following steps:

  1. Trigger the "Prepare release" workflow. This will automatically determine the next version, prepare the changelog, and create a pull request to main.

    gh workflow run prepare-release.yml -f level=minor
# or "major" or "patch"

  2. Review and merge the pull request created by the workflow.

  3. Trigger the "Publish release" workflow to tag and publish the release.

    gh workflow run publish-release.yml -f ref=main

    Optionally, specify the version explicitly:

    gh workflow run publish-release.yml -f ref=main -f version=$VERSION

  4. Verify the release appears on the GitHub releases page.