Skip to content

release-process.md

Latest commit

 

History

History
87 lines (66 loc) · 2.81 KB

release-process.md

File metadata and controls

87 lines (66 loc) · 2.81 KB

Release Process

This document outlines the automated release process for Void eID. The process is triggered by git tags and handles version synchronization, artifact building, and publishing.

Overview

The release workflow is designed to be fully automated. When a release tag (e.g., v1.2.3) is pushed to the repository, GitHub Actions orchestrates the entire process.

graph TD
    A[Dev Pushes Tag v1.2.3] -->|Triggers| B(Release Workflow)
    B --> C{Extract Version}
    C -->|Pass Version| E{Build & Push Artifacts}
    E --> F[Backend Image]
    E --> G[Frontend Image]
    E --> H[Murmur Image]
    F --> I[GHCR Registry]
    G --> I
    H --> I
    style A fill:#f9f,stroke:#333,stroke-width:2px
    style I fill:#9f9,stroke:#333,stroke-width:2px
Loading

Detailed Workflow

1. Version Extraction (update-repo-version)

The first job extracts the version version from the git tag (e.g., v1.0.0 -> 1.0.0) and makes it available to subsequent jobs.

Note

This workflow does not commit the version change back to main due to branch protection rules. The source code on main remains at the development version. However, all release artifacts (Binaries, Docker Images) are patched during the build process to contain the correct version number.

sequenceDiagram
    participant User
    participant GitHub as GitHub Actions

    User->>GitHub: Push Tag v1.2.3
    GitHub->>GitHub: Extract Version (1.2.3)
    GitHub->>GitHub: Trigger Build Jobs (with version input)
Loading

2. CI Validation (ci)

The standard CI pipeline runs to ensure the release verify code quality and tests. It receives the version from the previous step to ensure it tests the correct code state.

3. Build and Publish (build-and-push)

This matrix job builds Docker images for all components. Crucially, it patches the files again in the build environment to ensure the built artifacts contain the correct version metadata, even if the git tag checkout points to the pre-bump commit.

graph LR
    subgraph Matrix [Build Matrix]
        direction TB
        Backend[Backend Build]
        Frontend[Frontend Build]
        Murmur[Murmur Build]
    end

    Input(Version 1.2.3) --> Backend
    Input --> Frontend
    Input --> Murmur

    Backend -->|Docker Build| B_Img[void-eid-backend:1.2.3]
    Frontend -->|Docker Build| F_Img[void-eid-frontend:1.2.3]
    Murmur -->|Docker Build| M_Img[void-eid-murmur:1.2.3]

    B_Img --> GHCR
    F_Img --> GHCR
    M_Img --> GHCR
Loading

How to Release

To trigger a release:

  1. Ensure local main is up to date.
  2. Tag the commit: 
    git tag v1.2.3
git push origin v1.2.3
  3. Wait for the GitHub Action to complete.
  4. Pull the automated version bump commit: 
    git pull origin main