CI/CD

# .github/workflows/freshet.yml
name: freshet
on:
  pull_request:
    paths: ["models/**"]
  push:
    branches: [main]
    paths: ["models/**"]

env:
  FRESHET_VERSION: "0.1.0"
  STATE: https://<your-edge>/state/v1        # or a file path; see "State files in CI"

jobs:
  # Every PR: what would this rebuild, and does it fit the budget? Never commits.
  plan:
    if: github.event_name == 'pull_request'
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Install freshet
        run: |
          curl -sSL "https://github.com/lucheeseng827/freshet/releases/download/v$FRESHET_VERSION/freshet-v$FRESHET_VERSION-x86_64-unknown-linux-musl.tar.gz" | tar xz
          echo "$PWD/freshet-v$FRESHET_VERSION-x86_64-unknown-linux-musl" >> "$GITHUB_PATH"
      - name: Plan (fails over budget)
        env:
          FRESHET_STATE_TOKEN: ${{ secrets.FRESHET_READ_TOKEN }}   # no state:commit
        run: |
          set -o pipefail
          echo '```text' >> "$GITHUB_STEP_SUMMARY"
          freshet plan --project models --state "$STATE" --budget 50 | tee -a "$GITHUB_STEP_SUMMARY"
          echo '```' >> "$GITHUB_STEP_SUMMARY"

  # main: plan, run, then commit what actually ran.
  rebuild:
    if: github.event_name == 'push'
    runs-on: ubuntu-latest
    concurrency: freshet-rebuild               # one rebuild at a time
    environment: production
    env:
      FRESHET_STATE_TOKEN: ${{ secrets.FRESHET_STATE_TOKEN }}   # with state:commit
    steps:
      - uses: actions/checkout@v4
      - name: Install freshet
        run: |
          curl -sSL "https://github.com/lucheeseng827/freshet/releases/download/v$FRESHET_VERSION/freshet-v$FRESHET_VERSION-x86_64-unknown-linux-musl.tar.gz" | tar xz
          echo "$PWD/freshet-v$FRESHET_VERSION-x86_64-unknown-linux-musl" >> "$GITHUB_PATH"
      - name: Plan
        id: plan
        run: |
          freshet plan --project models --state "$STATE" --sql postgres --json > plan.json 2> plan.err
          cat plan.err
          echo "version=$(grep -oE 'version ([0-9]+|none)' plan.err | head -1 | cut -d' ' -f2 || true)" >> "$GITHUB_OUTPUT"
      - name: Run
        env:
          DATABASE_URL: ${{ secrets.DATABASE_URL }}
        run: ./scripts/run-plan.sh plan.json   # or freshet submit, or your Airflow trigger
      - name: Commit (only after the run succeeded)
        env:
          VERSION: ${{ steps.plan.outputs.version }}   # empty for a state file
        run: freshet plan --project models --state "$STATE" --commit ${VERSION:+--expect-version "$VERSION"}

# .gitlab-ci.yml
variables:
  FRESHET_VERSION: "0.1.0"
  STATE: https://<your-edge>/state/v1

.freshet:
  image: debian:bookworm-slim
  before_script:
    - apt-get update -q && apt-get install -y -q curl ca-certificates jq postgresql-client
    - curl -sSL "https://github.com/lucheeseng827/freshet/releases/download/v$FRESHET_VERSION/freshet-v$FRESHET_VERSION-x86_64-unknown-linux-musl.tar.gz" | tar xz
    - export PATH="$PWD/freshet-v$FRESHET_VERSION-x86_64-unknown-linux-musl:$PATH"

freshet:plan:
  extends: .freshet
  rules:
    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
      changes: [models/**/*]
  variables:
    FRESHET_STATE_TOKEN: $FRESHET_READ_TOKEN      # masked CI/CD variable, no state:commit
  script:
    - freshet plan --project models --state "$STATE" --budget 50

freshet:rebuild:
  extends: .freshet
  rules:
    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
      changes: [models/**/*]
  resource_group: freshet-state                 # one rebuild at a time
  environment: production
  script:
    - freshet plan --project models --state "$STATE" --sql postgres --json > plan.json 2> plan.err
    - cat plan.err
    - VERSION=$(grep -oE 'version ([0-9]+|none)' plan.err | head -1 | cut -d' ' -f2 || true)
    - ./scripts/run-plan.sh plan.json
    - freshet plan --project models --state "$STATE" --commit ${VERSION:+--expect-version "$VERSION"}

#!/usr/bin/env bash
# freshet-ci.sh plan|apply — the same two jobs for any CI (Jenkins, Buildkite, CircleCI…).
#   FRESHET_STATE    a state file, or https://<your-edge>/state/v1 (+ FRESHET_STATE_TOKEN)
#   FRESHET_PROJECT  the models directory (default: models)
#   FRESHET_BUDGET   optional CU cap for `plan`
#   FRESHET_DIALECT  --sql dialect for `apply` (default: postgres)
#   FRESHET_RUNNER   the command that runs plan.json, and exits non-zero if the run failed
set -euo pipefail
case "${1:-}" in plan|apply) ;; *) echo "usage: $0 plan|apply" >&2; exit 2 ;; esac
: "${FRESHET_STATE:?set FRESHET_STATE}" "${FRESHET_RUNNER:=./scripts/run-plan.sh}"
project=${FRESHET_PROJECT:-models}

case "$1" in
  plan)
    freshet plan --project "$project" --state "$FRESHET_STATE" ${FRESHET_BUDGET:+--budget "$FRESHET_BUDGET"}
    ;;
  apply)
    for attempt in 1 2 3; do
      freshet plan --project "$project" --state "$FRESHET_STATE" \
        --sql "${FRESHET_DIALECT:-postgres}" --json > plan.json 2> plan.err
      cat plan.err >&2
      # hosted state prints the version it planned against; a state file prints none
      version=$(grep -oE 'version ([0-9]+|none)' plan.err | head -1 | cut -d' ' -f2 || true)
      # A failed run exits 1 whatever the runner returned (psql uses 3), so 3 below
      # can only mean "state moved".
      "$FRESHET_RUNNER" plan.json || { echo "run failed; nothing committed" >&2; exit 1; }
      rc=0
      freshet plan --project "$project" --state "$FRESHET_STATE" --commit \
        ${version:+--expect-version "$version"} || rc=$?
      [ "$rc" = 3 ] || exit "$rc"        # 0: committed; anything but 3: a real failure
      echo "state moved while this ran; re-planning (attempt $attempt)" >&2
    done
    exit 3
    ;;
esac

$ FRESHET_STATE=https://<your-edge>/state/v1 FRESHET_BUDGET=50 ./scripts/freshet-ci.sh plan
$ FRESHET_STATE=https://<your-edge>/state/v1 ./scripts/freshet-ci.sh apply