* docs: migrate ui docs to docs universe * created yarn workspace * added eslint and tsconfig configurations * fix eslint configurations * fixed eslint configurations * shared tailwind configurations * added shared ui package * added more shared components * migrating more components * made details components shared * move InlineCode component * moved InputText * moved Loading component * Moved Modal component * moved Select components * Moved Tooltip component * moved Search components * moved ColorMode provider * Moved Notification components and providers * used icons package * use UI colors in api-reference * moved Navbar component * used Navbar and Search in UI docs * added Feedback to UI docs * general enhancements * fix color mode * added copy colors file from ui-preset * added features and enhancements to UI docs * move Sidebar component and provider * general fixes and preparations for deployment * update docusaurus version * adjusted versions * fix output directory * remove rootDirectory property * fix yarn.lock * moved code component * added vale for all docs MD and MDX * fix tests * fix vale error * fix deployment errors * change ignore commands * add output directory * fix docs test * general fixes * content fixes * fix announcement script * added changeset * fix vale checks * added nofilter option * fix vale error
175 lines
4.4 KiB
YAML
175 lines
4.4 KiB
YAML
name: Documentation Tests
|
|
on:
|
|
pull_request:
|
|
paths:
|
|
- www/**
|
|
|
|
jobs:
|
|
docs-test:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Cancel Previous Runs
|
|
uses: styfle/cancel-workflow-action@0.11.0
|
|
with:
|
|
access_token: ${{ github.token }}
|
|
|
|
- name: Checkout
|
|
uses: actions/checkout@v3
|
|
with:
|
|
fetch-depth: 0
|
|
|
|
- name: Setup Node.js environment
|
|
uses: actions/setup-node@v3
|
|
with:
|
|
node-version: "16.14.0"
|
|
cache: "yarn"
|
|
|
|
- name: Install dependencies
|
|
uses: ./.github/actions/cache-deps
|
|
with:
|
|
extension: docs
|
|
|
|
- name: Install Workspace dependencies
|
|
working-directory: www
|
|
run: yarn install
|
|
- name: Build Docusaurus website
|
|
working-directory: www
|
|
env:
|
|
NODE_OPTIONS: "--max-old-space-size=8192"
|
|
API_URL: "https://docs.medusajs.com"
|
|
run: yarn build:docs
|
|
|
|
vale-docs:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Cancel Previous Runs
|
|
uses: styfle/cancel-workflow-action@0.11.0
|
|
with:
|
|
access_token: ${{ github.token }}
|
|
|
|
- name: Checkout
|
|
uses: actions/checkout@v3
|
|
with:
|
|
fetch-depth: 0
|
|
|
|
- name: Get Directories to Scan
|
|
working-directory: www/vale
|
|
run: ./get-files.sh docs content references
|
|
id: directories
|
|
|
|
- name: Vale Linter
|
|
uses: errata-ai/vale-action@reviewdog
|
|
with:
|
|
files: ${{ steps.directories.outputs.LIST }}
|
|
fail_on_error: true
|
|
vale_flags: '--minAlertLevel=error'
|
|
reporter: github-pr-check
|
|
token: ${{ github.token }}
|
|
filter_mode: nofilter
|
|
env:
|
|
REVIEWDOG_GITHUB_API_TOKEN: ${{ github.token }}
|
|
|
|
vale-ui:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Cancel Previous Runs
|
|
uses: styfle/cancel-workflow-action@0.11.0
|
|
with:
|
|
access_token: ${{ github.token }}
|
|
|
|
- name: Checkout
|
|
uses: actions/checkout@v3
|
|
with:
|
|
fetch-depth: 0
|
|
|
|
- name: Get Directories to Scan
|
|
working-directory: www/vale
|
|
run: ./get-files.sh ui src/content/docs
|
|
id: directories
|
|
|
|
- name: Vale Linter
|
|
uses: errata-ai/vale-action@reviewdog
|
|
with:
|
|
files: ${{ steps.directories.outputs.LIST }}
|
|
fail_on_error: true
|
|
vale_flags: '--minAlertLevel=error'
|
|
reporter: github-pr-check
|
|
token: ${{ github.token }}
|
|
filter_mode: nofilter
|
|
env:
|
|
REVIEWDOG_GITHUB_API_TOKEN: ${{ github.token }}
|
|
|
|
vale-api:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Cancel Previous Runs
|
|
uses: styfle/cancel-workflow-action@0.11.0
|
|
with:
|
|
access_token: ${{ github.token }}
|
|
|
|
- name: Checkout
|
|
uses: actions/checkout@v3
|
|
with:
|
|
fetch-depth: 0
|
|
|
|
- name: Get Directories to Scan
|
|
working-directory: www/vale
|
|
run: ./get-files.sh api-reference app/_mdx
|
|
id: directories
|
|
|
|
- name: Vale Linter
|
|
uses: errata-ai/vale-action@reviewdog
|
|
with:
|
|
files: ${{ steps.directories.outputs.LIST }}
|
|
fail_on_error: true
|
|
vale_flags: '--minAlertLevel=error'
|
|
reporter: github-pr-check
|
|
token: ${{ github.token }}
|
|
filter_mode: nofilter
|
|
env:
|
|
REVIEWDOG_GITHUB_API_TOKEN: ${{ github.token }}
|
|
|
|
eslint:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Cancel Previous Runs
|
|
uses: styfle/cancel-workflow-action@0.11.0
|
|
with:
|
|
access_token: ${{ github.token }}
|
|
|
|
- name: Checkout
|
|
uses: actions/checkout@v3
|
|
with:
|
|
fetch-depth: 0
|
|
|
|
- name: Install dependencies
|
|
working-directory: www
|
|
run: yarn install
|
|
|
|
- name: Run Eslint
|
|
working-directory: www
|
|
run: yarn lint:content
|
|
|
|
code-docs-eslint:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Cancel Previous Runs
|
|
uses: styfle/cancel-workflow-action@0.11.0
|
|
with:
|
|
access_token: ${{ github.token }}
|
|
|
|
- name: Checkout
|
|
uses: actions/checkout@v3
|
|
with:
|
|
fetch-depth: 0
|
|
|
|
- name: Install Monorepo dependencies
|
|
run: yarn install
|
|
|
|
- name: Install dependencies
|
|
working-directory: www
|
|
run: yarn install
|
|
|
|
- name: Run Eslint
|
|
working-directory: www
|
|
run: yarn lint |