Skip to content

ci: add CI/CD workflows and environment setup #330

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
saddlepaddle merged 5 commits into from
Dec 12, 2025
Merged

ci: add CI/CD workflows and environment setup #330

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3110628
WIP
saddlepaddle Dec 12, 2025
6941477
WIP
saddlepaddle Dec 12, 2025
1c52c84
WIP
saddlepaddle Dec 12, 2025
8744819
WIP
saddlepaddle Dec 12, 2025
65a1418
ci: add build job for CLI and Desktop apps
saddlepaddle Dec 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .github/templates/cleanup-comment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## 🧹 Preview Cleanup Complete

The following preview resources have been cleaned up:

<table>
<tr>
<th align="left">Service</th>
<th align="center">Status</th>
</tr>
<tr>
<td><img src="https://neon.com/favicon.ico" width="20" height="20"> <strong>Database (Neon)</strong></td>
<td align="center">$NEON_STATUS</td>
</tr>
</table>
Comment on lines +5 to +14
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Dec 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Add alt text to <img> and avoid MD036 emphasis-as-heading.

-<td><img src="https://neon.com/favicon.ico" width="20" height="20"> <strong>Database (Neon)</strong></td>
+<td><img alt="Neon" src="https://neon.com/favicon.ico" width="20" height="20"> <strong>Database (Neon)</strong></td>

-*Preview resources have been processed for cleanup*
+Preview resources have been processed for cleanup.

Also applies to: 19-19

🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

11-11: Images should have alternate text (alt text)

(MD045, no-alt-text)

🤖 Prompt for AI Agents 
In .github/templates/cleanup-comment.md around lines 5-14 (also applies to line
19), the <img> tag lacks an alt attribute and the bold text is triggering MD036
emphasis-as-heading; add a meaningful alt attribute to the image (e.g.,
alt="Neon logo") and replace the bold heading markup with plain text or a proper
heading syntax to avoid emphasis-as-heading (or remove unnecessary emphasis),
ensuring the table cell content remains valid markdown without using bold as a
heading.


Thank you for your contribution! 🎉

---
*Preview resources have been processed for cleanup*
46 changes: 46 additions & 0 deletions .github/templates/preview-comment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
## 🚀 Preview Deployment

### 🔗 Preview Links

<table>
<tr>
<th align="left">Service</th>
<th align="center">Status</th>
<th align="left">Link</th>
</tr>
<tr>
<td><img src="https://neon.com/favicon.ico" width="20" height="20"> <strong>Database (Neon)</strong></td>
<td align="center">$DATABASE_STATUS</td>
<td>$DATABASE_LINK</td>
</tr>
<tr>
<td><img src="https://vercel.com/favicon.ico" width="20" height="20"> <strong>API (Vercel)</strong></td>
<td align="center">$API_STATUS</td>
<td>$API_LINK</td>
</tr>
<tr>
<td><img src="https://vercel.com/favicon.ico" width="20" height="20"> <strong>Web (Vercel)</strong></td>
<td align="center">$WEB_STATUS</td>
<td>$WEB_LINK</td>
</tr>
<tr>
<td><img src="https://vercel.com/favicon.ico" width="20" height="20"> <strong>Marketing (Vercel)</strong></td>
<td align="center">$MARKETING_STATUS</td>
<td>$MARKETING_LINK</td>
</tr>
<tr>
<td><img src="https://vercel.com/favicon.ico" width="20" height="20"> <strong>Admin (Vercel)</strong></td>
<td align="center">$ADMIN_STATUS</td>
<td>$ADMIN_LINK</td>
</tr>
<tr>
<td><img src="https://vercel.com/favicon.ico" width="20" height="20"> <strong>Docs (Vercel)</strong></td>
<td align="center">$DOCS_STATUS</td>
<td>$DOCS_LINK</td>
</tr>
</table>
Comment on lines +5 to +41
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Dec 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Add alt text to <img> and avoid MD036 emphasis-as-heading.
markdownlint will keep failing on MD045/MD036 as written.

-<td><img src="https://neon.com/favicon.ico" width="20" height="20"> <strong>Database (Neon)</strong></td>
+<td><img alt="Neon" src="https://neon.com/favicon.ico" width="20" height="20"> <strong>Database (Neon)</strong></td>

-<td><img src="https://vercel.com/favicon.ico" width="20" height="20"> <strong>API (Vercel)</strong></td>
+<td><img alt="Vercel" src="https://vercel.com/favicon.ico" width="20" height="20"> <strong>API (Vercel)</strong></td>
...
-*Preview updates automatically with new commits*
+Preview updates automatically with new commits.

Also applies to: 45-45

🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

12-12: Images should have alternate text (alt text)

(MD045, no-alt-text)

17-17: Images should have alternate text (alt text)

(MD045, no-alt-text)

22-22: Images should have alternate text (alt text)

(MD045, no-alt-text)

27-27: Images should have alternate text (alt text)

(MD045, no-alt-text)

32-32: Images should have alternate text (alt text)

(MD045, no-alt-text)

37-37: Images should have alternate text (alt text)

(MD045, no-alt-text)

🤖 Prompt for AI Agents 
.github/templates/preview-comment.md lines 5-41 (and also line 45): the <img>
tags in the service table are missing alt attributes and some bolded text is
being treated as emphasis-as-heading (MD036) causing markdownlint failures; add
meaningful alt text to each <img> (e.g., alt="Neon favicon", alt="Vercel
favicon") and remove/avoid emphasis-as-heading by not using leading emphasis for
headings—use plain text or proper heading markup with a blank line before it so
MD036/MD045 no longer trigger; apply the same fixes at line 45.


---

*Preview updates automatically with new commits*

81 changes: 39 additions & 42 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,107 +1,104 @@
name: CI

on:
pull_request:
push:
branches: [main]
pull_request:
types: [opened, synchronize]

jobs:
lint:
name: Lint
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
- name: Check out code
uses: actions/checkout@v4

- uses: oven-sh/setup-bun@v2
- name: Setup Bun
uses: oven-sh/setup-bun@v2
with:
bun-version: 1.3.3

- name: Cache dependencies
uses: actions/cache@v4
with:
path: |
~/.bun/install/cache
key: ${{ runner.os }}-bun-${{ hashFiles('**/bun.lock') }}
path: ~/.bun/install/cache
key: ${{ runner.os }}-bun-${{ hashFiles('bun.lock') }}

- name: Install dependencies
run: bun install --frozen

- name: Run lint
- name: Lint
run: bun run lint

typecheck:
name: Typecheck
test:
name: Test
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
- name: Check out code
uses: actions/checkout@v4

- uses: oven-sh/setup-bun@v2
- name: Setup Bun
uses: oven-sh/setup-bun@v2
with:
bun-version: 1.3.3

- name: Cache dependencies
uses: actions/cache@v4
with:
path: |
~/.bun/install/cache
key: ${{ runner.os }}-bun-${{ hashFiles('**/bun.lock') }}
path: ~/.bun/install/cache
key: ${{ runner.os }}-bun-${{ hashFiles('bun.lock') }}

- name: Install dependencies
run: bun install --frozen

- name: Run typecheck
run: bun run typecheck
- name: Test
run: bun run test

build:
name: Build
typecheck:
name: Typecheck
runs-on: ubuntu-latest
env:
# Placeholder values for build validation (not used at runtime)
DATABASE_URL: "postgresql://placeholder:placeholder@localhost:5432/placeholder"
DATABASE_URL_UNPOOLED: "postgresql://placeholder:placeholder@localhost:5432/placeholder"

steps:
- uses: actions/checkout@v4
- name: Check out code
uses: actions/checkout@v4

- uses: oven-sh/setup-bun@v2
- name: Setup Bun
uses: oven-sh/setup-bun@v2
with:
bun-version: 1.3.3

- name: Cache dependencies
uses: actions/cache@v4
with:
path: |
~/.bun/install/cache
key: ${{ runner.os }}-bun-${{ hashFiles('**/bun.lock') }}
path: ~/.bun/install/cache
key: ${{ runner.os }}-bun-${{ hashFiles('bun.lock') }}

- name: Install dependencies
run: bun install --frozen

- name: Run build
run: bun run build
- name: Typecheck
run: bun run typecheck

test:
name: Test
build:
name: Build
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
- name: Check out code
uses: actions/checkout@v4

- uses: oven-sh/setup-bun@v2
- name: Setup Bun
uses: oven-sh/setup-bun@v2
with:
bun-version: 1.3.3

- name: Cache dependencies
uses: actions/cache@v4
with:
path: |
~/.bun/install/cache
key: ${{ runner.os }}-bun-${{ hashFiles('**/bun.lock') }}
path: ~/.bun/install/cache
key: ${{ runner.os }}-bun-${{ hashFiles('bun.lock') }}

- name: Install dependencies
run: bun install --frozen

- name: Run test
run: bun run test
- name: Build CLI and Desktop
run: bun turbo run build --filter=@superset/cli --filter=@superset/desktop
24 changes: 14 additions & 10 deletions .github/workflows/cleanup-preview.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,25 +11,29 @@ jobs:
permissions:
contents: read
pull-requests: write

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Delete Neon branch
id: delete-branch
uses: neondatabase/delete-branch-action@v3.2.0
id: neon-cleanup
uses: neondatabase/delete-branch-action@v3
continue-on-error: true
with:
project_id: ${{ vars.NEON_PROJECT_ID }}
branch: ${{ github.event.pull_request.head.ref }}
api_key: ${{ secrets.NEON_API_KEY }}

- name: Update comment with cleanup status
- name: Generate cleanup comment
run: |
NEON_STATUS="${{ steps.neon-cleanup.outcome == 'success' && '✅' || '⚠️' }}"
export NEON_STATUS
envsubst < .github/templates/cleanup-comment.md > final-comment.md

- name: Update comment
if: always()
uses: thollander/actions-comment-pull-request@v3
with:
file-path: final-comment.md
comment-tag: "🚀-preview-deployment"
message: |
## 🧹 Preview Cleanup Complete

The following preview resources have been cleaned up:
- ${{ steps.delete-branch.outcome == 'success' && '✅' || '⚠️' }} Neon database branch

Thank you for your contribution! 🎉
Loading