Zimin A.N.
02591466cc
Раньше release tag создавал v2.X.Y, build images, но values-prod.yaml в
ordinis-infra оставался указывать на старый tag (либо unset → fall to
:latest). Это создавало divergence:
- Auto deploy через trigger-deploy-prod использовал runtime
UPSTREAM_IMAGE_TAG = новый tag → правильный deploy.
- Manual deploy через infra repo (helm upgrade -f values-prod.yaml)
использовал static values → старый tag → split-brain ноды через
:latest cache (см. ordinis-infra MR !10 fix).
Новый job 'propose-prod-image-bump':
- Triggers только на tag pipeline (semver v*.*.*).
- Needs все docker-* jobs (images должны быть в registry).
- Clones ordinis-infra, патчит image.tag в values-prod.yaml через awk
с scope-tracking (только image: block, не writer/readApi/etc).
- Commit + push branch + создаёт MR через GitLab API.
- Reviewer approve → merge → infra pipeline auto-катит deploy-prod.
Git становится единственным источником истины: HEAD ordinis-infra main
всегда отражает что задеплоено на prod.
Setup: новая CI variable INFRA_PROJECT_TOKEN (group-level access token
scope: write_repository, api, role: Developer). Без неё job exits early
с подсказкой — pipeline не блокируется (allow_failure: true).
132 lines
4.7 KiB
Markdown
132 lines
4.7 KiB
Markdown
# Release Automation
|
|
|
|
Ordinis uses **semantic-release** для автоматического создания tag'ов на основе
|
|
conventional commits. После merge в `main` CI анализирует commits, решает
|
|
bump (patch/minor/major), генерирует `CHANGELOG.md` и пушит tag `vX.Y.Z`.
|
|
|
|
Tag pipeline далее собирает images и ждёт manual gate на `trigger-deploy-prod`.
|
|
Prod deploy остаётся под human control — semantic-release создаёт tag,
|
|
human кликает Deploy.
|
|
|
|
## One-time setup
|
|
|
|
1. **Create Project Access Token** (GitLab UI):
|
|
- `Settings → Access Tokens → Add new token`
|
|
- Name: `semantic-release`
|
|
- Role: `Maintainer`
|
|
- Scopes: `write_repository`, `api`
|
|
- Expiry: 1 год (renew annually)
|
|
|
|
2. **Add CI variable**:
|
|
- `Settings → CI/CD → Variables → Add variable`
|
|
- Key: `GITLAB_TOKEN`
|
|
- Value: (token из шага 1)
|
|
- Type: `Variable`
|
|
- Flags: `Masked` ✅, `Protected` ✅ (только main + tag pipelines)
|
|
|
|
После этого release job в `.gitlab-ci.yml` будет работать.
|
|
|
|
### Auto-PR в ordinis-infra (опционально)
|
|
|
|
`propose-prod-image-bump` job открывает MR в `ordinis-infra` после каждого
|
|
release tag — bump'ит `image.tag` в `values-prod.yaml` на свежий immutable
|
|
SHA tag (e.g. `v2-16-0-abc12345`). Чинит historical bug когда manual deploys
|
|
через infra repo получали `:latest` (stale cache → split-brain pods).
|
|
|
|
Setup:
|
|
|
|
3. **Create Group Access Token** в `2-6/2-6-4/terravault`:
|
|
- `Group → Settings → Access Tokens → Add new token`
|
|
- Name: `ordinis-ci-infra-bump`
|
|
- Role: `Developer`
|
|
- Scopes: `write_repository`, `api`
|
|
- Expiry: 1 год
|
|
|
|
4. **Add CI variable в ordinis project (367)**:
|
|
- Key: `INFRA_PROJECT_TOKEN`
|
|
- Value: (token из шага 3)
|
|
- Flags: `Masked` ✅, `Protected` ✅
|
|
|
|
Без этой переменной job exits early (`allow_failure: true`), tag pipeline
|
|
не блокируется. Manual MR в `ordinis-infra` остаётся всегда доступен как
|
|
fallback.
|
|
|
|
## Commit conventions
|
|
|
|
Conventional Commits (https://www.conventionalcommits.org/):
|
|
|
|
| Type | Bump | Section в CHANGELOG |
|
|
|------|------|---------------------|
|
|
| `feat:` | **minor** | ✨ Features |
|
|
| `fix:` | patch | 🐛 Fixes |
|
|
| `perf:` | patch | ⚡ Performance |
|
|
| `refactor:` | patch | ♻️ Refactoring |
|
|
| `revert:` | patch | ⏪ Reverts |
|
|
| `docs:` | none | 📝 Docs |
|
|
| `chore:` | none | hidden |
|
|
| `test:` | none | hidden |
|
|
| `style:` | none | hidden |
|
|
| `ci:` | none | hidden |
|
|
| `build:` | none | hidden |
|
|
|
|
**Breaking changes** — добавь `BREAKING CHANGE:` в footer commit message → major bump.
|
|
|
|
```
|
|
feat(api): drop legacy v1 endpoint
|
|
|
|
BREAKING CHANGE: /api/v1/* paths больше не поддерживаются.
|
|
Все клиенты должны мигрировать на /api/v2.
|
|
```
|
|
|
|
> **⚠ Lesson learned (v2.0.0 false-major):** до 2026-05-12 в .releaserc.json
|
|
> noteKeywords содержал bare `"BREAKING"`. Слово «Breaking» в обычном
|
|
> commit body (например «Breaking down PATCH into atomic ops…») триггерило
|
|
> major bump. Конфиг исправлен — оставлены только canonical
|
|
> `BREAKING CHANGE` / `BREAKING CHANGES`. Когда нужен major — используй
|
|
> точно эти триггеры в footer.
|
|
|
|
## Skip release for specific commit
|
|
|
|
Если хочешь смержить `feat:` или `fix:` но **не** делать release сейчас —
|
|
добавь `[skip ci]` в commit message ИЛИ используй non-release type
|
|
(`chore:`, `docs:`, etc).
|
|
|
|
```
|
|
chore(deps): bump axios 1.7 -> 1.8
|
|
```
|
|
|
|
## Loop prevention
|
|
|
|
Release job создаёт commit `chore(release): vX.Y.Z [skip ci]`. `[skip ci]` —
|
|
стандартный GitLab marker, новый pipeline не триггерится. Версия package.json
|
|
+ CHANGELOG.md обновляются в этом коммите.
|
|
|
|
## Branch policy
|
|
|
|
Релизы создаются ТОЛЬКО с `main`. Feature branches (`feat/*`, `fix/*`) собираются
|
|
для staging но НЕ создают tag'и. Релиз = merge в main + успешный staging deploy +
|
|
наличие релизных commits.
|
|
|
|
## Local dry-run
|
|
|
|
Проверить что semantic-release решит сделать без push:
|
|
|
|
```bash
|
|
cd ordinis-admin-ui
|
|
pnpm install
|
|
npx semantic-release --dry-run --no-ci
|
|
```
|
|
|
|
Покажет следующую версию + preview CHANGELOG entries.
|
|
|
|
## Rollback
|
|
|
|
Если случайно зарелизили — удали tag:
|
|
|
|
```bash
|
|
git tag -d v1.3.1
|
|
git push origin :refs/tags/v1.3.1
|
|
```
|
|
|
|
GitLab Releases UI — удали release object отдельно.
|