RELEASE.md

Release process

This document is intended for doc2go maintainers only.

Prerequisites

The following must be installed for a new release:

• GitHub CLI (gh)
• Changie

Steps

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

1. Set an environment variable VERSION specifying the release version with the 'v' prefix. Be aware that doc2go follows semver.

   VERSION=$(changie next auto)

2. Create a branch to prepare the release off main.

    git checkout main
    git pull
    git checkout -b prepare-$VERSION
    ```

3. Prepare the release notes for the new version.

    ```bash
    changie batch $VERSION
    changie merge
    ```

4. Stage and commit everything.

    ```bash
    git add CHANGELOG.md .changes
    git commit -m "Prepare release $VERSION"
    ```

5. Create a pull request against the release branch.

    ```bash
    gh pr create -B release -t "Release $VERSION" -b ""
    ```

6. Once the build is green, merge the branch.

    ```bash
    gh pr merge -m -d
    ```

7. Tag and push the release.

    ```bash
    git tag -a "$VERSION" -m "$VERSION"
    git push origin $VERSION
    ```

8. Update main.

    ```bash
    git checkout main
    git merge origin/release
    git push
    ```