Github Action을 이용한 모노레포 라이브러리 문서 자동화

├── app // 아직 사용안함
├── packages
│   ├── react-design-system // 개인 프로젝트로 사용할 디자인 시스템
│   ├── react-shared // 리액트에 의존한 유틸
│   │   ...
│   └── typescript-utils // 타입스크립트로 만들어진 유틸 함수
└── docs // 문서 배포를 위한 workspace

npx create-docusaurus@latest my-website classic --typescript

my-website
├── blog
│   ├── 2019-05-28-hola.md
│   ├── 2019-05-29-hello-world.md
│   └── 2020-05-30-welcome.md
├── docs
│   ├── doc1.md
│   ├── doc2.md
│   ├── doc3.md
│   └── mdx.md
├── src
│   ├── css
│   │   └── custom.css
│   └── pages
│       ├── styles.module.css
│       └── index.js
├── static
│   └── img
├── docusaurus.config.js
├── package.json
├── README.md
├── sidebars.js
└── yarn.lock

./docs/scripts/generateDocsFromMD.ts
 
import * as fse from "fs-extra";
import globby from "globby";
import path from "path";
import { DOCS_ROOT, PACKAGES_ROOT } from "./const";
 
export async function generateDocsFromMD() {
  console.log("⚙️ Generating docs from MD...");
 
  return await Promise.all([copyMDDocs(DOCS_ROOT, ["'**/*.md"])]);
}
 
async function copyMDDocs(outdir: string, exclude: string[]) {
  const filepaths = (
    await globby("**/*.md", {
      cwd: PACKAGES_ROOT,
      ignore: exclude,
    })
  ).filter((path) => !path.includes("node_modules")); // node_modules를 제외한 폴더 내부에 md 파일을 전부 불러옵니다.
 
  console.log("filepaths", filepaths);
 
  await Promise.all(
    filepaths.map(async (filepath) => {
      const source = path.join(PACKAGES_ROOT, filepath);
      const destination = path.join(outdir, filepath.replace("src/", ""));
 
      console.log("outdir:", destination);
      await fse.ensureDir(path.dirname(destination));
      await fse.copy(source, destination);
    })
  ); // ./docs/docs 폴더에 복사합니다.
 
  console.log("✅ Copied MD docs to", outdir);
}
 

"scripts": {
    "docs": "rm -rf docs && ts-node ./scripts/index.ts && docusaurus build"
  },

name: Deploy Docs to GitHub Pages
 
on:
  push:
    branches:
      - main
 
  workflow_dispatch:
 
permissions:
  contents: read
  pages: write
  id-token: write
 
concurrency:
  group: "pages"
  cancel-in-progress: true
 
jobs:
  build-and-deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
 
    steps:
      - name: Check out code
        uses: actions/checkout@v4
        with:
          fetch-depth: 2
 
      - uses: pnpm/action-setup@v3
        with:
          version: 8
 
      - name: Setup Node.js environment
        uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: "pnpm"
 
      - name: Install dependencies
        run: pnpm install
 
      - name: Build docs
        run: pnpm run docs
 
      - name: Setup Pages
        uses: actions/configure-pages@v3
 
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v2
        with:
          path: "./docs/build"
 
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v2

name: Typescript-Utils Test and Auto Merge
 
on:
  pull_request:
    branches:
      - main
    paths:
      - "packages/typescript-utils/src/**" # paths를 통해 해당하는 workspace에서만 실행합니다.
  push:
    branches:
      - main
    paths:
      - "packages/typescript-utils/src/**"
 
jobs:
  build:
    name: Build and Test
    runs-on: ubuntu-latest
    # To use Remote Caching, uncomment the next lines and follow the steps below.
    # env:
    #  TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
    #  TURBO_TEAM: ${{ vars.TURBO_TEAM }}
 
    steps:
      - name: Check out code
        uses: actions/checkout@v4
        with:
          fetch-depth: 2
 
      - uses: pnpm/action-setup@v3
        with:
          version: 8
 
      - name: Setup Node.js environment
        uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: "pnpm"
 
      - name: Install dependencies
        run: pnpm install
 
      # - name: Build
      #   run: pnpm build
 
      - name: Test
        run: pnpm test --filter=@repo/typescript-utils # --filter 옵션을 사용하면 해당 workspace에서만 명령어를 수행할 수 있습니다.