seedgen 0.3.0

Zero-config database seed data generator with deterministic, constraint-safe fake data
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

name: 'SeedGen'
description: 'Seed a PostgreSQL database with deterministic, constraint-safe fake data'
author: 'ff4f'

branding:
  icon: 'database'
  color: 'green'

inputs:
  database_url:
    description: 'PostgreSQL connection URL (e.g. postgres://user:pass@host:5432/dbname).'
    required: true

  scenario:
    description: 'Built-in scenario template: `ecommerce`, `saas`, `blog`, or `social`.'
    required: false
    default: ''

  scenario_file:
    description: 'Path to a custom YAML scenario file (relative to repo root).'
    required: false
    default: ''

  seed:
    description: 'RNG seed for deterministic output. Same seed = identical data every run.'
    required: false
    default: ''

  rows:
    description: 'Default rows per table when no scenario override applies.'
    required: false
    default: '10'

  entities:
    description: 'Per-table row count overrides, comma-separated (e.g. `users=100,orders=500`).'
    required: false
    default: ''

  locale:
    description: 'Locale for fake data (en, id, ja, de, fr).'
    required: false
    default: 'en'

  fast:
    description: 'Use the COPY protocol for faster inserts (boolean: true/false).'
    required: false
    default: 'false'

  truncate_first:
    description: 'TRUNCATE all target tables before inserting (boolean: true/false).'
    required: false
    default: 'false'

  version:
    description: 'SeedGen version to install (e.g. `v0.1.0`). Use `latest` for the most recent release.'
    required: false
    default: 'latest'

runs:
  using: 'composite'
  steps:
    - name: Install SeedGen
      shell: bash
      env:
        SEEDGEN_VERSION: ${{ inputs.version }}
      run: |
        set -euo pipefail

        case "${RUNNER_OS}-${RUNNER_ARCH}" in
          Linux-X64)   ARTIFACT="seedgen-linux-amd64" ;;
          Linux-ARM64) ARTIFACT="seedgen-linux-arm64" ;;
          macOS-X64)   ARTIFACT="seedgen-darwin-amd64" ;;
          macOS-ARM64) ARTIFACT="seedgen-darwin-arm64" ;;
          Windows-X64) ARTIFACT="seedgen-windows-amd64.exe" ;;
          *)
            echo "::error::Unsupported runner: ${RUNNER_OS}-${RUNNER_ARCH}"
            exit 1
            ;;
        esac

        if [ "$SEEDGEN_VERSION" = "latest" ]; then
          URL="https://github.com/ff4f/seedgen/releases/latest/download/${ARTIFACT}"
        else
          URL="https://github.com/ff4f/seedgen/releases/download/${SEEDGEN_VERSION}/${ARTIFACT}"
        fi

        if [ "$RUNNER_OS" = "Windows" ]; then
          BIN_NAME="seedgen.exe"
        else
          BIN_NAME="seedgen"
        fi

        INSTALL_DIR="${RUNNER_TEMP}/seedgen-bin"
        BIN_PATH="${INSTALL_DIR}/${BIN_NAME}"
        mkdir -p "$INSTALL_DIR"

        echo "Downloading ${ARTIFACT} (version: ${SEEDGEN_VERSION})"
        curl --fail --location --silent --show-error --retry 3 --retry-delay 2 \
          --output "$BIN_PATH" "$URL"
        chmod +x "$BIN_PATH"

        echo "$INSTALL_DIR" >> "$GITHUB_PATH"
        echo "::notice::SeedGen ${SEEDGEN_VERSION} installed"
        "$BIN_PATH" --version

    - name: Run seedgen generate
      shell: bash
      env:
        SG_DB_URL: ${{ inputs.database_url }}
        SG_SCENARIO: ${{ inputs.scenario }}
        SG_SCENARIO_FILE: ${{ inputs.scenario_file }}
        SG_SEED: ${{ inputs.seed }}
        SG_ROWS: ${{ inputs.rows }}
        SG_ENTITIES: ${{ inputs.entities }}
        SG_LOCALE: ${{ inputs.locale }}
        SG_FAST: ${{ inputs.fast }}
        SG_TRUNCATE: ${{ inputs.truncate_first }}
      run: |
        set -euo pipefail

        args=("generate" "--url" "$SG_DB_URL")
        [ -n "$SG_SCENARIO" ]      && args+=("--scenario" "$SG_SCENARIO")
        [ -n "$SG_SCENARIO_FILE" ] && args+=("--file" "$SG_SCENARIO_FILE")
        [ -n "$SG_SEED" ]          && args+=("--seed" "$SG_SEED")
        [ -n "$SG_ROWS" ]          && args+=("--rows" "$SG_ROWS")
        [ -n "$SG_ENTITIES" ]      && args+=("--entities" "$SG_ENTITIES")
        [ -n "$SG_LOCALE" ]        && args+=("--locale" "$SG_LOCALE")
        [ "$SG_FAST" = "true" ]    && args+=("--fast")
        [ "$SG_TRUNCATE" = "true" ] && args+=("--truncate-first")

        # Echo parameters by name (never the full args, which include the URL with password).
        echo "::group::seedgen parameters"
        echo "  scenario:       ${SG_SCENARIO:-<none>}"
        echo "  scenario_file:  ${SG_SCENARIO_FILE:-<none>}"
        echo "  seed:           ${SG_SEED:-<time-based>}"
        echo "  rows:           $SG_ROWS"
        echo "  entities:       ${SG_ENTITIES:-<none>}"
        echo "  locale:         $SG_LOCALE"
        echo "  fast:           $SG_FAST"
        echo "  truncate_first: $SG_TRUNCATE"
        echo "::endgroup::"

        seedgen "${args[@]}"