Skip to content

Commit 0349dac

Browse files
authored
docs: update README.md (#13)
1 parent 13610ee commit 0349dac

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,12 @@
22
[![release](https://img.shields.io/github/actions/workflow/status/wislertt/zerv-flow/cd.yml?branch=main&label=release&logo=github)](https://github.com/wislertt/zerv-flow/actions/workflows/cd.yml)
33
[![quality gate status](https://sonarcloud.io/api/project_badges/measure?project=wislertt_zerv-flow&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=wislertt_zerv-flow)
44
[![security rating](https://sonarcloud.io/api/project_badges/measure?project=wislertt_zerv-flow&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=wislertt_zerv-flow)
5-
[![vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=wislertt_zerv-flow&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=wislertt_zerv-flow)[![codecov](https://img.shields.io/codecov/c/github/wislertt/zerv-flow?label=codecov&logo=codecov)](https://codecov.io/gh/wislertt/zerv-flow)
5+
[![vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=wislertt_zerv-flow&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=wislertt_zerv-flow)
6+
[![codecov](https://img.shields.io/codecov/c/github/wislertt/zerv-flow?label=codecov&logo=codecov)](https://codecov.io/gh/wislertt/zerv-flow)
67

78
# zerv flow
89

9-
This repository demonstrates a complete CI/CD solution for multi-environment deployments, integrating the [**zerv**](https://github.com/wislertt/zerv) versioning tool with GitHub Actions for automated versioning and release workflows.
10+
A demonstration of [**zerv**](https://github.com/wislertt/zerv) in action. Shows how to implement automated versioning for CI/CD pipelines, generating multiple formats (semver, PEP440, Docker tags) with flexible branching strategy framework.
1011

1112
## Overview
1213

@@ -29,7 +30,7 @@ This repository demonstrates a complete CI/CD solution for multi-environment dep
2930
1. Fork this repository
3031
2. Install zerv locally for testing
3132
3. Create a PR to test the workflow
32-
4. Add `deploy-d`, `deploy-n`, or `deploy` labels to trigger deployments
33+
4. Add `deploy-d`, `deploy-n`, `deploy` and `pre-release` labels
3334

3435
## Prerequisites
3536

@@ -49,6 +50,11 @@ This repository demonstrates a complete CI/CD solution for multi-environment dep
4950
- **Version formats**: This repository demonstrates 3 formats: - Semver: For git repository tags and releases - PEP440: For Python package versions - Docker Tag: For container registry tags
5051
- Note: This demo repository only echoes these formats as examples, but in a real deployment pipeline they would be used for their respective purposes.
5152
- Note: Configure zerv to generate formats based on your deployment requirements and constraints. See [zerv documentation](https://github.com/wislertt/zerv) for all supported formats.
53+
- **Deployment triggers**: Uses PR labels with configurable prefixes:
54+
- `deploy-` prefix for environment-specific deployments (e.g., `deploy-d`, `deploy-n`)
55+
- `deploy` for environment-less deployments (e.g., immutable releases)
56+
- `pre-release` for creating release candidates with tagging
57+
- These label prefixes can be configured to match your deployment naming conventions
5258

5359
## Branching Strategy Design
5460

@@ -80,17 +86,17 @@ This repository demonstrates a complete CI/CD solution for multi-environment dep
8086
The following scenarios demonstrate how the deployment flow works in practice:
8187

8288
- **Initial State**: Only the main branch exists. All environments (development, nonproduction, production) and environment-less deployments reference version `v1.1.2` from the main branch.
83-
![Initial Deployment State](.github/docs/assets/deployment-flow-1.excalidraw.svg)
89+
![Initial Deployment State](https://raw.githubusercontent.com/wislertt/zerv-flow/dev/.github/docs/assets/deployment-flow-1.excalidraw.svg)
8490

8591
- **Feature Branch Deployment**: A `feature/1` branch is created with PR labels `deploy-n` and `deploy`. The nonproduction environment deploys version `v1.1.3-alpha.1.post.2` from the feature branch and becomes locked to it. Development and production remain on main branch `v1.1.2`. The environment-less deployment creates a new version `v1.1.3-alpha.1.post.2` without overriding previous versions.
86-
![Feature Branch Deployment](.github/docs/assets/deployment-flow-2.excalidraw.svg)
92+
![Feature Branch Deployment](https://raw.githubusercontent.com/wislertt/zerv-flow/dev/.github/docs/assets/deployment-flow-2.excalidraw.svg)
8793

8894
- **Concurrent Feature Deployment**: While `feature/1` PR is active, a `feature/2` branch is created with PR labels `deploy-d`, `deploy-n`, and `deploy`. Nonproduction deployment fails due to being locked by `feature/1`. Development deploys successfully with version `v1.1.3-alpha.2.post3` from `feature/2`. Environment-less deployment creates another new version `v1.1.3-alpha.2.post.3` alongside the existing version.
89-
![Concurrent Feature Deployment](.github/docs/assets/deployment-flow-3.excalidraw.svg)
95+
![Concurrent Feature Deployment](https://raw.githubusercontent.com/wislertt/zerv-flow/dev/.github/docs/assets/deployment-flow-3.excalidraw.svg)
9096

9197
## Branch Rules and Version Generation (Configurable)
9298

93-
This repository uses the default branch rules from `zerv flow` command. For complete implementation details, see the shared workflow at [zerv/.github/workflows/shared-zerv-versioning.yml](https://github.com/wislertt/zerv/blob/main/.github/workflows/shared-zerv-versioning.yml).
99+
This repository uses the default branch rules from `zerv flow` command. For complete implementation details, see the [shared workflow](https://github.com/wislertt/zerv/blob/main/.github/workflows/shared-zerv-versioning.yml).
94100

95101
- **Feature branches** (default): Generate alpha pre-releases with branch-based identification
96102
- Numbered feature branches (`feature/1/xyz`): Extracts number from branch name

0 commit comments

Comments
 (0)