# CI/CD Pipeline Guide {#cicd-pipeline-guide}


Continuous integration and deployment pipeline configuration.


## Overview {#overview}


Gauzy uses GitHub Actions for CI/CD with the following stages:





```mermaid
graph LR
    PR[Pull Request] --> CI[CI Build]
    CI --> Lint[Lint]
    CI --> Test[Test]
    CI --> Build[Build]
    Build --> Docker[Docker Build]
    Docker --> Deploy[Deploy]
```






## CI Pipeline (Pull Requests) {#ci-pipeline-pull-requests}


Triggered on every PR:

```yaml
name: CI
on:
  pull_request:
    branches: [develop, main]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v6
        with:
          node-version: 20
      - run: yarn install --frozen-lockfile
      - run: yarn lint
      - run: yarn test
      - run: yarn build
```


## CD Pipeline (Main Branch) {#cd-pipeline-main-branch}


Triggered on merge to main:

1. **Build** Docker images
2. **Push** to GHCR (`ghcr.io/ever-co/gauzy-*`)
3. **Deploy** to staging/production


## Docker Build Pipeline {#docker-build-pipeline}


```yaml
- name: Build and push
  uses: docker/build-push-action@v5
  with:
    context: .
    push: true
    tags: ghcr.io/ever-co/gauzy-api:latest
    build-args: |
      VERDACCIO_TOKEN=${{ secrets.VERDACCIO_TOKEN }}
```


## Deployment Environments {#deployment-environments}


| Environment | Trigger         | Target              |
| ----------- | --------------- | ------------------- |
| Dev         | Push to develop | dev.example.com     |
| Staging     | Push to main    | staging.example.com |
| Production  | Manual release  | app.example.com     |


## Required Secrets {#required-secrets}


| Secret                | Description             |
| --------------------- | ----------------------- |
| `GITHUB_TOKEN`        | Auto-provided by GH     |
| `VERDACCIO_TOKEN`     | Private registry token  |
| `DOCKER_HUB_USERNAME` | Container registry auth |
| `SENTRY_DSN`          | Error tracking          |
| `DEPLOY_KEY`          | SSH deploy key          |


## Related Pages {#related-pages}


- [Production Deployment](https://sourcey-gauzy.pages.dev/devops/production-deployment/index.md) — deploy guide
- [Private Registry](https://sourcey-gauzy.pages.dev/devops/private-registry/index.md) — Verdaccio
- [Release Process](https://sourcey-gauzy.pages.dev/development/release-process/index.md) — release workflow