README.md

View on GitHub

GitOps Promoter facilitates environment promotion for config managed via GitOps.

Video of the GitOps Promoter UI as a change is promoted through three environments

Key Features

Drift-free promotion process
Robust promotion gating system
Complete integration with git and SCM tooling
No fragile automated changes to user-facing files

The main ideas behind the project are explained in "Space Age GitOps: The Rise of the Humble Pull Request".

A live demo is presented in "Space Age GitOps: Lifting off with Argo Promotions".

The promotion gating system is detailed in "No More Pipelines: Reconciling Environment Promotion Via Commit Statuses".

Example

apiVersion: promoter.argoproj.io/v1alpha1
kind: PromotionStrategy
metadata:
  name: example-promotion-strategy
spec:
  gitRepositoryRef:
    name: example-git-repo
  activeCommitStatuses:
    - key: argocd-app-health
  proposedCommitStatuses:
    - key: security-scan
  environments:
    - branch: environment/dev
    - branch: environment/test
    - branch: environment/prod
      autoMerge: false
      activeCommitStatuses:
      - key: performance-test
      proposedCommitStatuses:
      - key: deployment-freeze

Getting Started

The project is currently experimental, please use with caution. See the docs site for setup instructions.

Contributing

See the Contributing page in the documentation.

Roadmap

See the Roadmap in the documentation for planned features.

Users

If you're using GitOps Promoter, please add yourself to USERS.md!

If you're evaluating GitOps Promoter, we'd love to hear from you — please open a discussion to share your feedback.