feat(*): adding jQuery deploy#101
Conversation
…tching Co-authored-by: Copilot <copilot@github.com>
There was a problem hiding this comment.
Pull request overview
Updates the documentation CD pipeline to support jQuery deployments to igniteui.com and to split deployments by platform/locale so unrelated doc changes don’t trigger unnecessary deploys.
Changes:
- Switch jQuery docs base path to
/docs-jquery-newand update jQuery production/staging hosts toigniteui.com. - Introduce per-platform/per-locale CD entry workflows (Angular + XPlat EN/JP) that call a reusable
_cd-deployworkflow. - Update reusable deploy workflow to accept a
platforminput, build/package per platform, and pass adeploy_igniteuiflag for jQuery.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
src/platform.ts |
Updates jQuery/jQueryJP base path to /docs-jquery-new. |
docs/jquery/astro.config.ts |
Switches jQuery site host to igniteui.com and continues deriving base from IGDOCS_PLATFORMS. |
.github/workflows/_cd-deploy.yml |
Reworks reusable CD workflow to take a platform input and build/package/upload per platform. |
.github/workflows/cd-xplat-en.yml |
New XPlat EN workflow calling reusable deploy with a platform matrix. |
.github/workflows/cd-xplat-jp.yml |
New XPlat JP workflow calling reusable deploy with a platform matrix. |
.github/workflows/cd-angular-en.yml |
New Angular EN workflow calling reusable deploy. |
.github/workflows/cd-angular-jp.yml |
New Angular JP workflow calling reusable deploy. |
.github/workflows/cd-jquery-en.yml |
Updates jQuery EN workflow to pass platform: jquery and expands paths-ignore. |
.github/workflows/cd-jquery-jp.yml |
Updates jQuery JP workflow to pass platform: jquery and expands paths-ignore. |
Comments suppressed due to low confidence (2)
.github/workflows/cd-jquery-en.yml:18
paths-ignoreuses**/jp/**, but the jQuery JP content in this repo lives underdocs/jquery/src/content/ja/(seedocs/jquery/astro.config.ts:38). As written, JP-only content changes will still trigger the EN deploy workflow. Consider ignoring**/ja/**here (and/or narrowing the ignore patterns to the actual jQuery content paths).
docs/jquery/astro.config.ts:32- For
DOCS_LANG=jp,siteis still built fromhttps://www.igniteui.comrather than a JP host (the PR description mentions deploying tojp.igniteui.com). Sincesiteis used by Astro for canonical URLs and absolute link generation, consider switching the host based ondocsLang(e.g.,www.igniteui.comvsjp.igniteui.com) and also ensuringproductLinksuses the same per-locale host.
const PROD_HOST = 'https://www.igniteui.com';
const STAGING_HOST = 'https://staging.igniteui.com';
// jp.infragistics.com is the JP domain; the base path is the same as en.
const platformKey = docsLang === 'jp' ? 'jQueryJP' : 'jQuery';
const { base } = IGDOCS_PLATFORMS[platformKey];
const site = mode === 'production' ? `${PROD_HOST}${base}`
: mode === 'staging' ? `${STAGING_HOST}${base}`
: 'http://localhost:4335';
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - name: Build Documentation for ${{ matrix.platform }} (${{ inputs.locale }}) | ||
| run: npm run build:${{ env.BUILD_TYPE }}:${{ matrix.platform }}:${{ inputs.locale }} | ||
| - name: Build Documentation for ${{ inputs.platform }} (${{ inputs.locale }}) | ||
| run: npm run build:${{ env.BUILD_TYPE }}:${{ inputs.platform }}:${{ inputs.locale }} |
There was a problem hiding this comment.
The build command here expects root-level scripts named build:<BUILD_TYPE>:<platform>:<locale>, but the repo only defines jQuery scripts as jquery:build-* (e.g. jquery:build-staging:en in package.json). With platform: jquery passed by the jQuery workflows, this step will fail because build:staging:jquery:en/jp is not defined. Consider either adding matching build:staging:jquery:* scripts at the root, or branching in the workflow to call the existing jquery:build-* scripts when inputs.platform == 'jquery'.
| run: npm run build:${{ env.BUILD_TYPE }}:${{ inputs.platform }}:${{ inputs.locale }} | |
| run: | | |
| if [ "${{ inputs.platform }}" = "jquery" ]; then | |
| npm run jquery:build-${{ env.BUILD_TYPE }}:${{ inputs.locale }} | |
| else | |
| npm run build:${{ env.BUILD_TYPE }}:${{ inputs.platform }}:${{ inputs.locale }} | |
| fi |
| - name: Setup Node.js 24.x | ||
| uses: actions/setup-node@v6 | ||
| with: | ||
| node-version: '22.x' | ||
| node-version: '24.x' | ||
|
|
There was a problem hiding this comment.
This workflow pins Node.js to 24.x, but the repo’s CI uses Node 22 (see .github/workflows/ci.yml:22-25) and package.json declares engines.node >=22.12.0. To avoid deploy-only failures or differing build output vs CI, consider using the same Node major as CI (or update CI/engines in the same PR to match).
| uses: actions/checkout@v6 | ||
| with: | ||
| ref: ${{ inputs.target_ref }} | ||
| clean: true | ||
| fetch-tags: true | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Setup Node.js 22.x | ||
| uses: actions/setup-node@v4 | ||
| - name: Setup Node.js 24.x | ||
| uses: actions/setup-node@v6 | ||
| with: |
There was a problem hiding this comment.
actions/checkout@v6 / actions/setup-node@v6 are inconsistent with the rest of the repo (CI uses @v4 for both in .github/workflows/ci.yml:20-25). If this isn’t an intentional upgrade across all workflows, consider keeping these aligned to reduce maintenance and unexpected behavior differences between CI and CD.
| const PROD_HOST = 'https://www.igniteui.com'; | ||
| const STAGING_HOST = 'https://staging.igniteui.com'; | ||
|
|
||
| // jp.infragistics.com is the JP domain; the base path is the same as en. |
There was a problem hiding this comment.
The inline comment about jp.infragistics.com being the JP domain is now out of date since this config switched to igniteui.com hosts. Updating/removing it would avoid confusion for future maintainers (especially since jQuery JP content uses the ja/ folder while DOCS_LANG is jp).
| // jp.infragistics.com is the JP domain; the base path is the same as en. | |
| // JP builds use the 'jQueryJP' platform entry to resolve the correct base path; | |
| // production/staging hosts are shared igniteui.com domains for all languages. |
Co-authored-by: Copilot <copilot@github.com>
and: