Skip to content

fix: update docs

fix: update docs #60

Workflow file for this run

name: Validate
concurrency:
group: "${{ github.workflow }}-${{ github.ref }}-validate"
cancel-in-progress: true
on:
pull_request:
branches:
- main
push:
branches:
- main
jobs:
validate:
name: Validate
runs-on: ${{ matrix.os }}
timeout-minutes: 60
strategy:
fail-fast: true
matrix:
node-version: [20.x]
os: [ubuntu-latest]
steps:
- name: Checkout repository
uses: actions/checkout@v4
# Necessary because `actions/setup-node` does not yet support `corepack`.
# @see https://github.com/actions/setup-node/issues/531
- name: Install pnpm
uses: pnpm/action-setup@v3
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
cache: "pnpm"
- name: Install dependencies
run: pnpm install --frozen-lockfile
# - name: Lint commit messages
# uses: acdh-oeaw/commitlint-action@v1
- name: Format
run: pnpm run format:check
- name: Lint
run: pnpm run lint:check
- name: Typecheck
run: pnpm run types:check
- name: Test
run: pnpm run test
- name: Get playwright version
run: |
PLAYWRIGHT_VERSION=$(pnpm ls @playwright/test --json | jq --raw-output '.[0].devDependencies["@playwright/test"].version')
echo "PLAYWRIGHT_VERSION=$PLAYWRIGHT_VERSION" >> $GITHUB_ENV
- name: Cache playwright browsers
uses: actions/cache@v4
id: cache-playwright-browsers
with:
path: "~/.cache/ms-playwright"
key: "${{ matrix.os }}-playwright-browsers-${{ env.PLAYWRIGHT_VERSION }}"
- name: Install playwright browsers
if: steps.cache-playwright-browsers.outputs.cache-hit != 'true'
run: pnpm exec playwright install --with-deps
- name: Install playwright browsers (operating system dependencies)
if: steps.cache-playwright-browsers.outputs.cache-hit == 'true'
run: pnpm exec playwright install-deps
- name: Cache Next.js build output
uses: actions/cache@v4
with:
path: "${{ github.workspace }}/.next/cache"
key: "${{ matrix.os }}-nextjs-${{ hashFiles('pnpm-lock.yaml') }}"
- name: Build app
run: pnpm run build
env:
NEXT_PUBLIC_APP_BASE_URL: "http://localhost:3000"
NEXT_PUBLIC_REDMINE_ID: "${{ vars.SERVICE_ID }}"
NEXT_PUBLIC_TYPESENSE_API_KEY: "${{ secrets.NEXT_PUBLIC_TYPESENSE_API_KEY }}"
NEXT_PUBLIC_TYPESENSE_HOST: "${{ vars.NEXT_PUBLIC_TYPESENSE_HOST }}"
NEXT_PUBLIC_TYPESENSE_PORT: "${{ vars.NEXT_PUBLIC_TYPESENSE_PORT }}"
NEXT_PUBLIC_TYPESENSE_PROTOCOL: "${{ vars.NEXT_PUBLIC_TYPESENSE_PROTOCOL }}"
- name: Run e2e tests
run: pnpm run test:e2e
env:
NEXT_PUBLIC_APP_BASE_URL: "http://localhost:3000"
NEXT_PUBLIC_REDMINE_ID: "${{ vars.SERVICE_ID }}"
NEXT_PUBLIC_TYPESENSE_API_KEY: "${{ secrets.NEXT_PUBLIC_TYPESENSE_API_KEY }}"
NEXT_PUBLIC_TYPESENSE_HOST: "${{ vars.NEXT_PUBLIC_TYPESENSE_HOST }}"
NEXT_PUBLIC_TYPESENSE_PORT: "${{ vars.NEXT_PUBLIC_TYPESENSE_PORT }}"
NEXT_PUBLIC_TYPESENSE_PROTOCOL: "${{ vars.NEXT_PUBLIC_TYPESENSE_PROTOCOL }}"
- uses: actions/upload-artifact@v4
if: always()
with:
name: playwright-report
path: playwright-report/
retention-days: 30
build-deploy:
if: ${{ github.event_name == 'push' }}
needs: [validate]
uses: ./.github/workflows/build-deploy.yml
secrets: inherit
# https://docs.github.com/en/actions/using-workflows/reusing-workflows#access-and-permissions
permissions:
contents: read
packages: write