Release Process

This document describes how to release a new version of the YubiHSM Connector Docker image.

Prerequisites

Push access to the main repository
GitHub CLI (optional, for easier tag creation)

Steps to Release

Ensure your local repository is up to date:

git fetch origin
git checkout main
git pull origin main

Create and push a new tag following semantic versioning:

# Using git
git tag v1.0.0
git push origin v1.0.0

# Or using GitHub CLI
gh release create v1.0.0

The GitHub Actions workflow will automatically:
- Build the Docker image for amd64 architecture
- Push it to GitHub Container Registry with the following tags:
  - ghcr.io/axlabs/yubihsm-connector-docker:v1.0.0 (exact version)
  - ghcr.io/axlabs/yubihsm-connector-docker:1.0 (minor version)
  - ghcr.io/axlabs/yubihsm-connector-docker:main (branch tag)
Verify the release:
- Check the Actions tab for successful workflow completion
- Verify the new package is listed in the Packages section
- Test pulling and running the new image:
```
docker pull ghcr.io/axlabs/yubihsm-connector-docker:v1.0.0
```

Version Numbers

We follow Semantic Versioning:

MAJOR version for incompatible API changes
MINOR version for backwards-compatible functionality additions
PATCH version for backwards-compatible bug fixes

Troubleshooting

If the workflow fails:

Check the workflow logs in the Actions tab
Ensure the repository has proper permissions for GitHub Packages
Verify the tag format matches v*.*.*