Skip to content

RELEASE.md

Latest commit

 

History

History
127 lines (83 loc) · 3.56 KB

RELEASE.md

File metadata and controls

127 lines (83 loc) · 3.56 KB

Release

This document outlines the process for creating a new release for Directory packages. All code block examples below use version v1.3.0; update the version accordingly.

The Directory release is split into two phases:

  • API module release: Go module tags only, no root tag and no artifacts.
  • Server release: root tag, server module tags, images, Helm charts, CLI binaries, and GitHub Release.

1. Prepare API Module Release

Prepare the API module set release branch:

task release:create:api RELEASE_VERSION=v1.3.0

This prepares only the api module set:

  • github.com/agntcy/dir/api
  • github.com/agntcy/dir/client
  • github.com/agntcy/dir/utils

Open a pull request from the generated release branch, wait for approval, and merge it into main.

2. Tag API Modules

After the API release pull request is merged, update your local main branch:

git checkout main
git pull origin main

Create and push only the API module tags:

git tag api/v1.3.0
git tag client/v1.3.0
git tag utils/v1.3.0

git push origin api/v1.3.0 client/v1.3.0 utils/v1.3.0

Do not create the root v1.3.0 tag during this phase. Root tags trigger artifact releases.

2a. Optional: Release API Consumers

After the API module tags are pushed, you can update API consumers with the new api, client, and utils tags and create releases for them.

Released API consumers:

This step is useful when those projects need to publish releases against the new API module versions before the Directory server release. The cli and server dependency updates can happen later in the server release preparation step.

3. Prepare Server Release

Prepare the server module set release branch:

task release:create:server RELEASE_VERSION=v1.3.0

This prepares only the server module set:

  • github.com/agntcy/dir/cli
  • github.com/agntcy/dir/tests
  • github.com/agntcy/dir/server
  • github.com/agntcy/dir/reconciler

If optional API consumer releases were created in step 2a, update the corresponding dependencies as well:

  • github.com/agntcy/dir-mcp
  • github.com/agntcy/dir-importer
  • github.com/agntcy/dir-runtime

If the release preparation updates Go module versions, tidy the module files before pushing the release branch:

task deps:tidy

Open a pull request from the generated release branch, wait for approval, and merge it into main.

4. Create Root Release Tag

After the server release pull request is merged, update your local main branch:

git checkout main
git pull origin main

Create and push the root release tag:

git tag -a v1.3.0
git push origin v1.3.0

The root tag triggers the release workflow, which publishes:

  • container images
  • Helm charts
  • CLI binaries
  • draft GitHub Release

Please note that the release tag is not necessarily associated with the release preparation commit. For example, if bug fixes were required after this commit, they can be merged and included in the release.

5. Publish Release

  • Wait until the release workflow completes successfully.
  • Navigate to the Releases page and verify the draft release description and assets.
  • Click Edit on the draft release, then click Publish Release.

Publishing the root GitHub Release creates only the server-side module tags:

  • cli/v1.3.0
  • tests/v1.3.0
  • server/v1.3.0
  • reconciler/v1.3.0

It does not re-tag api, client, or utils.