Skip to content

Commit 96fdb69

Browse files
committed
Add workflow
1 parent bfae101 commit 96fdb69

1 file changed

Lines changed: 61 additions & 0 deletions

File tree

.github/workflows/sync.yml

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: Update API Documentation
2+
3+
on:
4+
# TODO: add a remote trigger so remix can trigger after releases
5+
workflow_dispatch:
6+
7+
jobs:
8+
docs:
9+
name: Update API Documentation
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Checkout remix-docs
13+
uses: actions/checkout@v4
14+
with:
15+
path: remix-docs
16+
ref: main
17+
18+
- name: Checkout remix
19+
uses: actions/checkout@v4
20+
with:
21+
repository: remix-run/remix
22+
path: remix
23+
ref: main
24+
25+
- name: Setup pnpm
26+
uses: pnpm/action-setup@v4
27+
with:
28+
version: 10
29+
30+
- name: Setup Node.js
31+
uses: actions/setup-node@v4
32+
with:
33+
node-version: 24
34+
cache: "pnpm"
35+
cache-dependency-path: remix/pnpm-lock.yaml
36+
37+
- name: Install Remix dependencies
38+
id: remix
39+
working-directory: remix
40+
run: |
41+
pnpm install --frozen-lockfile
42+
echo "remix_sha=$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT
43+
44+
- name: Generate/Sync Docs
45+
working-directory: remix-docs
46+
run: |
47+
pnpm run sync
48+
git add docs/
49+
50+
if [ -z "$(git status --porcelain)" ]; then
51+
echo "No changes detected"
52+
exit 0
53+
fi
54+
55+
git config user.name "github-actions[bot]"
56+
git config user.email "github-actions[bot]@users.noreply.github.com"
57+
58+
git commit -m "Updated API documentation from Remix SHA ${{ steps.remix.outputs.remix_sha }}"
59+
git push
60+
61+
echo "Pushed docs changes https://github.com/$GITHUB_REPOSITORY/commit/$(git rev-parse HEAD)"

0 commit comments

Comments
 (0)