[RFC] Release Lifecycle

.github/workflows/README.md

@@ -1,39 +1,216 @@
-## Prepare Release (`prepare-relese.yml`)
+# GitHub Workflows
 
-- manually
+This document provides an overview of all GitHub Actions workflows in this repository. For the complete release process documentation, see [RELEASE.md](../../RELEASE.md).
 
-## CI (`<queue|scu-at|scu-de|scu-es|scu-it>-build.yml`)
+---
 
-- on push
-  - paths: `<queue|scu-at|scu-de|scu-es|scu-it>/**`
-- manually
-- from `/run <queue|scu-at|scu-de|scu-es|scu-it> ci` comment
+## Slash Commands
 
-## Package (`package.yml`)
+All slash commands are dispatched via [`slash-commands.yml`](slash-commands.yml) when commenting on a Pull Request.
 
-- manually
-- from `/package <queue|scu-at|scu-de|scu-es|scu-it> <PACKAGE>` comment
+### `/run` Command (`command-run.yml`)
 
-## Queue Acceptance Tests (`queue-acceptance-tests.yml`)
+Triggers CI builds or acceptance tests.
 
-- on push
-  - branch: `main`
-  - tags-ignore: `queue/**/v*`
-- manually
-- from `/run queue acceptance-tests` comment
+| Usage                                   | Description                    |
+|-----------------------------------------|--------------------------------|
+| `/run <component> ci`                   | Run CI build for a component   |
+| `/run <component> build`                | Alias for `ci`                 |
+| `/run queue acceptance-tests`           | Run all queue acceptance tests |
+| `/run queue acceptance-tests <package>` | Run specific acceptance test   |
 
-## Enforce All Status Checks
-- on pull_request update
-- from `/check` comment
+**Components:** `queue`, `scu-at`, `scu-de`, `scu-es`, `scu-it`
 
-## Version
+### `/package` Command (`command-package.yml`)
 
-## Release (`release.yml`)
+Builds a package without deploying.
 
-- on push
-  - tags: `<queue|scu-at|scu-de|scu-es|scu-it>/**/v*`
+```
+/package <component> <package>
+```
 
-## Deploy (`deploy.yml`)
+**Example:** `/package queue SQLite`
 
-- manually (via Package)
-- from `/deploy <queue|scu-at|scu-de|scu-es|scu-it> <PACKAGE>` comment
+### `/deploy` Command (`command-package.yml`)
+
+Builds a package and deploys to sandbox.
+
+```
+/deploy <component> <package>
+```
+
+**Example:** `/deploy scu-de SwissbitCloudV2`
+
+**Behavior:**
+1. Builds the package with version based on branch (`-ci` or `-rc`)
+2. Updates comment with approval link (👀)
+3. On approval, deploys to sandbox
+4. Updates comment with success (🎉) or failure (😕)
+
+### `/release` Command (`command-release.yml`)
+
+Creates a version tag and GitHub release. Only works on release branches.
+
+```
+/release <component> <package>
+```
+
+**Example:** `/release queue SQLite`
+
+**Behavior:**
+1. Creates tag using `nbgv tag`
+2. Pushes tag to repository
+3. Creates GitHub release with appropriate release notes
+4. Updates comment with link to release
+
+### `/version` Command (`command-version.yml`)
+
+Removes the `-rc` prerelease suffix from the version. Only works on release branches.
+
+```
+/version
+```
+
+**Behavior:** Updates `version.json` to full release version (e.g., `1.3.68-rc` → `1.3.68`)
+
+### `/merge` Command (`command-merge.yml`)
+
+Merges a release PR with special conflict handling. Only works on release branches.
+
+```
+/merge
+```
+
+**Behavior:**
+1. Resolves `version.json` conflicts in favor of `main` branch
+2. Verifies all status checks pass
+3. Merges the PR
+
+---
+
+## Build Workflows
+
+CI workflows that run on push to component directories and can be triggered manually or via `/run`.
+
+| Workflow           | Trigger Paths | Manual Trigger   |
+|--------------------|---------------|------------------|
+| `queue-build.yml`  | `queue/**`    | `/run queue ci`  |
+| `scu-at-build.yml` | `scu-at/**`   | `/run scu-at ci` |
+| `scu-de-build.yml` | `scu-de/**`   | `/run scu-de ci` |
+| `scu-es-build.yml` | `scu-es/**`   | `/run scu-es ci` |
+| `scu-it-build.yml` | `scu-it/**`   | `/run scu-it ci` |
+| `scu-be-build.yml` | `scu-be/**`   | `/run scu-be ci` |
+
+### Queue Acceptance Tests (`queue-acceptance-tests.yml`)
+
+**Triggers:**
+- Push to `main` branch
+- Tag ignore: `queue/**/v*`
+- Manual: `/run queue acceptance-tests`
+
+**Options:**
+- Run all tests: `/run queue acceptance-tests`
+- Run specific test: `/run queue acceptance-tests SQLite`
+
+---
+
+## Package Workflows
+
+### Package (`package.yml`)
+
+Reusable workflow for building and packaging components.
+
+**Inputs:**
+- `pattern`: Project pattern to match
+- `directory`: Source directory
+- `commit`: Optional commit ref
+- `deploySandbox`: Deploy to sandbox after packaging
+
+**Called by:** `command-package.yml`, `release.yml`, individual package workflows
+
+### Component Package Workflows
+
+Pre-configured package workflows for each component:
+
+- `queue-package.yml`
+- `scu-at-package.yml`
+- `scu-de-package.yml`
+- `scu-es-package.yml`
+- `scu-it-package.yml`
+- `scu-be-package.yml`
+
+---
+
+## Release Workflows
+
+### Prepare Release (`prepare-release.yml`)
+
+**Trigger:** Manual (workflow dispatch)
+
+**Purpose:** Creates a release branch with RC version.
+
+**Actions:**
+1. Creates `release/vX.Y` branch from `main`
+2. Sets release branch version to `-rc`
+3. Bumps `main` to next version with `-ci`
+4. Creates PR from release branch to `main`
+
+### Release (`release.yml`)
+
+**Trigger:** GitHub release published with tag matching `<component>/<package>/v*`
+
+**Purpose:** Deploys a tagged release to production.
+
+**Actions:**
+1. Validates tag format
+2. Runs component-specific tests
+3. Packages the component
+4. Deploys to sandbox (for verification)
+5. Deploys to production
+
+### Deploy (`deploy.yml`)
+
+Reusable workflow for deploying packages to an environment.
+
+**Inputs:**
+- `package`: Package name to deploy
+- `environment`: Target environment (`sandbox` or `production`)
+
+**Deployments:**
+- v1 Packages (Azure Storage)
+- v2 Packages (Azure Storage)
+
+---
+
+## Utility Workflows
+
+### Enforce All Checks (`enforce-all-checks.yml`)
+
+**Triggers:**
+- Pull request updates
+
+**Purpose:** Waits for all status checks to complete.
+
+### Check Labels (`check-labels.yml`)
+
+Validates that PRs have required labels.
+
+### Check Linked Issue (`check-linked-issue.yml`)
+
+Validates that PRs are linked to issues.
+
+### CLA (`cla.yml`)
+
+Contributor License Agreement checking.
+
+### Manual Merging (`manual-merging.yml`)
+
+Makes sure that release PRs can not be merged manually.
+
+### Remove No Issue Label (`remove-no-issue-label.yml`)
+
+Automatically removes `no-issue` label when an issue is linked.
+
+### Smoketests (`smoketests.yml`)
+
+Runs smoke tests for release verification.

.github/workflows/enforce-all-checks.yml

@@ -1,11 +1,9 @@
 name: Summary
 on:
   pull_request:
-  repository_dispatch:
-    types: [check-command]
 
 concurrency:
-  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.event.client_payload.pull_request.number || github.ref }}
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number }}
   cancel-in-progress: true
 
 jobs:

.github/workflows/slash-commands.yml

@@ -26,5 +26,4 @@ jobs:
             deploy
             release
             version
-            check
             merge