oxygen-ui/.github/workflows/deploy-gh-pages.yml at main · jeradrutnam/oxygen-ui · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
# This workflow will deploy the docs as static content to GitHub Pages

name: 📘 Deploy Documentation
run-name: "${{ github.event.head_commit.message || format('📘 Deploy Documentation @wso2/oxygen-ui@{0}', inputs.version) }}"

on:
  workflow_dispatch:
    inputs:
      version:
        description: "Package version to deploy (e.g., 1.0.0)"
        required: false
        type: string
      basePath:
        description: |
          The base path to deploy the docs to. Default is "oxygen-ui" (https://wso2.github.io/oxygen-ui/).
          Note: Do not include a leading or trailing slash.
        default: "oxygen-ui"
        type: string

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
  group: "pages"
  cancel-in-progress: false

env:
  GH_TOKEN: ${{ secrets.UI_BOT_TOKEN }}

jobs:
  deploy:
    if: github.event_name == 'workflow_dispatch'
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    strategy:
      matrix:
        node-version: [lts/*]
        pnpm-version: [latest]
    steps:
      - name: ⬇️ Checkout
        id: checkout
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: 📦 Get Package Version
        id: version
        run: |
          VERSION=$(jq -r '.version' packages/oxygen-ui/package.json)
          echo "version=$VERSION" >> $GITHUB_OUTPUT
          echo "## 📘 Deploy Documentation" >> $GITHUB_STEP_SUMMARY
          echo "" >> $GITHUB_STEP_SUMMARY
          echo "**Package:** @wso2/oxygen-ui" >> $GITHUB_STEP_SUMMARY
          echo "**Version:** \`$VERSION\`" >> $GITHUB_STEP_SUMMARY

      - name: 🥡 Setup pnpm
        uses: pnpm/action-setup@v4
        with:
          version: ${{ matrix.pnpm-version }}
          run_install: false
          cache: true
          cache-dependency-path: pnpm-lock.yaml

      - name: 🟢 Setup node
        id: setup-node
        uses: actions/setup-node@v4
        with:
          node-version: ${{ matrix.node-version }}
          cache: 'pnpm'

      - name: 🎈 Get pnpm store directory
        id: get-pnpm-cache-dir
        run: |
          echo "::set-output name=pnpm_cache_dir::$(pnpm store path)"

      - name: 🧩 Install Dependencies
        id: install-dependencies
        run: pnpm install --frozen-lockfile

      - name: 🏗️ Build Project
        id: build
        run: |
          pnpm build

      - name: ⚙️ Setup Pages
        id: setup-pages
        uses: actions/configure-pages@v5

      - name: 🌩 Upload Artifact
        id: upload-artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: ./packages/oxygen-ui-docs/dist

      - name: 🔥 Deploy to GitHub Pages
        id: deploy-gh-pages
        uses: actions/deploy-pages@v4