Skip to content

Set up Liam ERD on GitHub Pages #1

Set up Liam ERD on GitHub Pages

Set up Liam ERD on GitHub Pages #1

Workflow file for this run

name: Deploy GitHub Pages
# see also https://github.com/giselles-ai/erd/settings/pages
on:
# NOTE: Regardless of whether it's a push or a workflow_dispatch, we must specify the branch or tag for deployment in each environment.
# see https://github.com/giselles-ai/erd/settings/environments
push:
branches:
- gh-pages
- main
paths:
- .github/workflows/github-pages.yml
- drizzle/**/*
workflow_dispatch:
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
# NOTE: Following the example below, the job is structured into distinct build and deploy phases.
# see https://docs.github.com/ja/pages/getting-started-with-github-pages/using-custom-workflows-with-github-pages
build:
runs-on: ubuntu-latest
timeout-minutes: 20
services:
# Note: Required for Step 2: Prepare the input file.
postgres:
image: postgres:15
ports:
- 5432:5432
options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
env:
POSTGRES_PASSWORD: password
steps:
# Step 1: Download SQL files from another repository
- name: Download SQL files
shell: bash
run: |
# base URL
base_url="https://github.com/giselles-ai/giselle/tree/main"
# download migration files
mkdir migrations
for i in $(seq -f "%03g" 1 20); do
migration_url="${base_url}/migrations/${i}.sql"
if curl --output /dev/null --silent --head --fail "$migration_url"; then
echo "Downloading $migration_url"
curl -o "migrations/${i}.sql" "$migration_url"
else
echo "No more migration files found at $migration_url"
break
fi
done
# merge all migration files
cat migrations/*.sql > migrations.sql
# Step 2: Prepare the input file
- name: Prepare the input file (dump.sql)
shell: bash
run: |
pg_dump_docker_image="postgres:15"
dbname="development"
echo "CREATE DATABASE ${dbname}" | psql "postgres://postgres:password@0.0.0.0:5432"
cat migrations.sql | psql "postgres://postgres:password@0.0.0.0:5432/${dbname}"
docker run --rm \
--network host \
${pg_dump_docker_image} \
pg_dump --schema-only --no-privileges --no-owner \
"postgres://postgres:password@0.0.0.0:5432/${dbname}" > dump.sql
# Step 3: Generate ERD (Entity-Relationship Diagram) to `./_site`
- name: Generate ERD
run: npx @liam-hq/cli@latest erd build --input dump.sql --format postgres
- run: mv ./dist ./_site
# Step 4: Upload Artifact
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
timeout-minutes: 10
needs: build
permissions:
id-token: write
pages: write
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4