Skip to content
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.

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

test: add docusaurus deploy CI tests #7714

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
57 changes: 57 additions & 0 deletions .github/workflows/tests-cli-deploy.yml
@@ -0,0 +1,57 @@
name: Tests CLI docusaurus deploy

on:
pull_request:
branches:
- main
paths:
- packages/docusaurus/src/commands/deploy.ts

# We queue those jobs on purpose to avoid race conditions
# Using a single static deploy branch: good enough
concurrency:
group: cli-deploy-singleton-group
cancel-in-progress: false

permissions:
contents: read

jobs:
test:
name: Tests
timeout-minutes: 5
runs-on: ubuntu-latest
strategy:
matrix:
node: ['16.14', '16', '18']
steps:
- name: Checkout
uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # v3
- name: Use Node.js ${{ matrix.node }}
uses: actions/setup-node@eeb10cff27034e7acf239c5d29f62154018672fd # v3
with:
node-version: ${{ matrix.node }}
cache: yarn
- name: Installation
run: yarn

- name: Cleanup Deployment Git Branch
run: git push origin --delete ci-deploy-test-branch
# Normally that branch does not exist, but who knows what can happen
continue-on-error: true

# We only test the deployment script, not the website build process
- name: Create artificial build dir
run: |
mkdir website/build
echo "CI CLI Deployment tests" > website/build/README.md

# We run twice the same CLI deployment command
# The script has different code for new vs existing remote branch
- name: Test CLI deployment 1 (new branch)
run: DEPLOYMENT_BRANCH=ci-deploy-test-branch yarn workspace website deploy --skip-build
- name: Test CLI deployment 2 (existing branch)
run: DEPLOYMENT_BRANCH=ci-deploy-test-branch yarn workspace website deploy --skip-build

- name: Cleanup Deployment Git Branch
run: git push origin --delete ci-deploy-test-branch
2 changes: 2 additions & 0 deletions packages/docusaurus/src/commands/deploy.ts
Expand Up @@ -14,6 +14,8 @@ import {hasSSHProtocol, buildSshUrl, buildHttpsUrl} from '@docusaurus/utils';
import {loadContext, type LoadContextOptions} from '../server';
import {build} from './build';

// Test temporary comment to trigger CI
Copy link
Collaborator

Choose a reason for hiding this comment

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

Just add the workflow file to trigger conditions as well?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

yes :D better idea


export type DeployCLIOptions = Pick<
LoadContextOptions,
'config' | 'locale' | 'outDir'
Expand Down