Skip to content

Commit 5307cc1

Browse files
Squashed commit of the following:
commit 7237405 Merge: 4a2ca0e 0ec203d Author: Ariel Caplan <[email protected]> Date: Mon Jan 27 12:49:29 2025 +0000 Merge pull request #5271 from Shopify/no-more-committed-docs-part-3 Remove doc generation from the changeset-manifests workflow commit 4a2ca0e Merge: 6fba53f a4e532a Author: Ariel Caplan <[email protected]> Date: Mon Jan 27 12:42:10 2025 +0000 Merge pull request #5270 from Shopify/no-more-committed-docs-part-2 Gitignore autogenerated docs commit 6fba53f Merge: ab1a33a e4f686a Author: Shaun Stanworth <[email protected]> Date: Mon Jan 27 12:20:53 2025 +0000 Merge pull request #5274 from Shopify/shauns/01-27-remotespecfication_includes_uidisclientprovided RemoteSpecfication includes uidIsClientProvided commit ab1a33a Merge: 8bd3b72 18783af Author: Shaun Stanworth <[email protected]> Date: Mon Jan 27 12:14:17 2025 +0000 Merge pull request #5273 from Shopify/shauns/01-27-app_management_schemas_are_found_on_the_main_branch App management schemas are found on the main branch commit 8bd3b72 Merge: 33f6fb8 21e4ea4 Author: Ariel Caplan <[email protected]> Date: Mon Jan 27 12:09:50 2025 +0000 Merge pull request #5263 from Shopify/no-more-committed-docs-part-1 Add workflow to build a deploy artifact and deploy to GH pages commit e4f686a Author: Shaun Stanworth <[email protected]> Date: Mon Jan 27 11:09:22 2025 +0000 RemoteSpecfication includes uidIsClientProvided commit 18783af Author: Shaun Stanworth <[email protected]> Date: Mon Jan 27 10:55:47 2025 +0000 App management schemas are found on the main branch commit 0ec203d Author: Ariel Caplan <[email protected]> Date: Sun Jan 26 14:45:39 2025 +0200 Remove doc generation from the changeset-manifests workflow We are using it when generating a released version, but it's no longer necessary if we are generating our docsite without committing the autogen pieces. commit a4e532a Author: Ariel Caplan <[email protected]> Date: Sun Jan 26 14:26:16 2025 +0200 Remove tracking from docs/api commit 21e4ea4 Author: Ariel Caplan <[email protected]> Date: Thu Jan 23 20:40:48 2025 +0200 Add workflow to build a deploy artifact and deploy to GH pages
1 parent e982d26 commit 5307cc1

File tree

663 files changed

+99
-4304
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

663 files changed

+99
-4304
lines changed

.github/workflows/docs.yml

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Deploy CLI Kit docs to Pages
2+
3+
on:
4+
push:
5+
branches: ["main"]
6+
workflow_dispatch:
7+
8+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
9+
permissions:
10+
contents: read
11+
pages: write
12+
id-token: write
13+
14+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
15+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
16+
concurrency:
17+
group: "pages"
18+
cancel-in-progress: false
19+
20+
# Necessary for setup-cli-deps action to work
21+
env:
22+
DEBUG: '1'
23+
SHOPIFY_CLI_ENV: development
24+
SHOPIFY_CONFIG: debug
25+
PNPM_VERSION: '8.15.7'
26+
27+
jobs:
28+
build:
29+
runs-on: ubuntu-latest
30+
steps:
31+
- name: Checkout
32+
uses: actions/checkout@v4
33+
- name: Setup deps
34+
uses: ./.github/actions/setup-cli-deps
35+
with:
36+
node-version: "22"
37+
- name: Build
38+
run: pnpm nx run-many --all --skip-nx-cache --target=docs:generate --output-style=stream
39+
- name: Upload artifact
40+
uses: actions/upload-pages-artifact@v3
41+
with:
42+
path: ./docs
43+
44+
# Deployment job
45+
deploy:
46+
environment:
47+
name: github-pages
48+
url: ${{ steps.deployment.outputs.page_url }}
49+
runs-on: ubuntu-latest
50+
needs: build
51+
steps:
52+
- name: Deploy to GitHub Pages
53+
id: deployment
54+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -171,3 +171,6 @@ testing.mjs
171171

172172
# ESLint reports
173173
eslint-report.json
174+
175+
# Generated docs
176+
docs/api

bin/get-graphql-schemas.js

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@ const schemas = [
3232
repo: 'shopify',
3333
pathToFile: 'areas/core/shopify/db/graphql/app_management_schema_unstable_public.graphql',
3434
localPath: './packages/app/src/cli/api/graphql/app-management/app_management_schema.graphql',
35-
branch: 'dd',
3635
},
3736
{
3837
repo: 'shopify',
@@ -43,13 +42,11 @@ const schemas = [
4342
repo: 'shopify',
4443
pathToFile: 'areas/core/shopify/db/graphql/webhooks_schema_unstable_public.graphql',
4544
localPath: './packages/app/src/cli/api/graphql/webhooks/webhooks_schema.graphql',
46-
branch: 'dd',
4745
},
4846
{
4947
repo: 'shopify',
5048
pathToFile: 'areas/core/shopify/db/graphql/functions_cli_api_schema_unstable_public.graphql',
5149
localPath: './packages/app/src/cli/api/graphql/functions/functions_cli_schema.graphql',
52-
branch: 'dd',
5350
},
5451
]
5552

docs/api/cli-kit/.nojekyll

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/api/cli-kit/assets/hierarchy.js

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/api/cli-kit/assets/highlight.css

Lines changed: 0 additions & 99 deletions
This file was deleted.

docs/api/cli-kit/assets/icons.js

Lines changed: 0 additions & 18 deletions
This file was deleted.

0 commit comments

Comments
 (0)