From 3c760d37e13aeedd458d70d85cd2e9680134f117 Mon Sep 17 00:00:00 2001
From: Yashvardhan Kukreja <yashvardhan@oplabs.co>
Date: Sat, 9 Nov 2024 01:39:16 +0530
Subject: [PATCH] feat: add documentation around the release process (#89)

---
 README.md  |  4 ++++
 RELEASE.md | 41 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 45 insertions(+)
 create mode 100644 RELEASE.md

diff --git a/README.md b/README.md
index 317c2c55..851dcc66 100644
--- a/README.md
+++ b/README.md
@@ -6,3 +6,7 @@ This repository is an extension of the [Optimism monorepo](https://github.com/et
 - op-conductor-mon: Monitors multiple op-conductor instances and provides a unified interface for reporting metrics.
 - op-signer: Thin gateway that supports `eth_signTransaction` RPC endpoint to sign ethereum tx payloads using private key stored in KMS
 - op-ufm: User facing monitoring creates transactions at regular intervals and observe transaction propagation across different RPC providers.
+
+## Release Process
+
+For the thoroughly defined process releasing services in this repository, please refer to [this document](./RELEASE.md).
\ No newline at end of file
diff --git a/RELEASE.md b/RELEASE.md
new file mode 100644
index 00000000..3a5376f9
--- /dev/null
+++ b/RELEASE.md
@@ -0,0 +1,41 @@
+# Release Process
+
+This document outlines the steps and processes for releasing a new version of one or more services in the `ethereum-optimism/infra` repository. The release process is driven by a GitHub Action (`Tag Service`) and subsequently triggers workflows in CircleCI to build and publish updated [these services/components](https://github.com/ethereum-optimism/infra/blob/main/ops/tag-service/tag-tool.py#L6-L13) selectively.
+
+## Release Process Overview
+
+1. **Tagging and Releasing with GitHub Action**
+
+   The release process is initiated by the "Tag Service" GitHub Action [here](https://github.com/ethereum-optimism/infra/actions/workflows/tag-service.yml). To trigger this action:
+   
+   - Select the branch containing the action—usually `main`.
+   - Choose the appropriate parameters to specify which services should be tagged and released.
+
+   > **Note**: Generally, the branch used for releases is `main` but if needed, you can use a different branch, say, if you'd like to create test releases from your branch.
+
+   The GitHub Action relies on `ops/tag-service`, which manages key release functions:
+   
+   - Identifying supported services.
+   - Determining version increments.
+   - Specifying precise tags for release.
+   - Configuring the release title and release notes.
+
+2. **Triggering the CircleCI Workflow**
+
+   Once a release tag is created by the above Github Action, the CircleCI `release` workflow is triggered. The configuration for this workflow is located in `.circle/config.yml` within the tagged release.
+
+   The workflow compares differences between the newly released tag and the `main` branch (the base revision). Based on these differences, it selectively toggles parameters to `true` only for services that have been updated. This prevents unnecessary builds or deployments when minor changes are made to unrelated services. [Refer to config here](https://github.com/ethereum-optimism/infra/blob/main/.circleci/config.yml#L18-L25).
+
+3. **Approval Process for Certain Tags**
+
+   For specific tags ([listed here](https://github.com/ethereum-optimism/infra/blob/main/.circleci/continue_config.yml#L533)), the workflow pauses with a hold step that requires approval from a member of the `@release-managers` team on `ethereum-optimism` GitHub Organisation. Once approved, the workflow continues.
+
+4. **Selective Component Release**
+
+   Depending on the type of released tag i.e. the component/service updated in the release, the following steps are selectively triggered to handle only that updated services:
+
+   - `docker-build`: Builds Docker images for that updated service.
+   - `docker-publish`: Publishes that image.
+   - `docker-tag-op-stack-release`: Attaches from more tags to that image compliant with OP-Stack releases.
+
+   Only the components that were updated in the GitHub release are built and delivered as Docker images.
\ No newline at end of file