envd-docs/.github/workflows/api_doc.yaml at main · tensorchord/envd-docs · 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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
name: sync doc file with envd

on:
  push:
    paths:
      - '.github/workflows/api_doc.yaml'
  pull_request:
    paths:
      - '.github/workflows/api_doc.yaml'
  repository_dispatch:
    types: [on-demand-test]
  workflow_dispatch:
  schedule:
    - cron: '0 2 * * *'

permissions:
  contents: read

jobs:
  sync_file:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
        with:
          python-version: '3.15'
      - uses: actions/setup-go@b7ad1dad31e06c5925ef5d2fc7ad053ef454303e # v7.0.0
        with:
          go-version: 'stable'
      - name: Checkout Envd-docs
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          fetch-depth: 0
          path: envd-docs
          persist-credentials: false
      - name: Checkout Envd
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          repository: 'tensorchord/envd'
          fetch-depth: 1
          path: envd
          persist-credentials: false
      - run: |
          mkdir -p envd-docs/hack/api/
          cp -r envd/envd/api/* envd-docs/hack/api/
      - name: Checkout Envd lib
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          repository: 'tensorchord/envdlib'
          fetch-depth: 1
          path: envdlib
          persist-credentials: false
      - run: |
          mkdir -p envd-docs/hack/api/lib/
          cp -r envdlib/src/* envd-docs/hack/api/lib/
      - name: Install latest envd
        run: |
          pushd envd
          make
          cp bin/envd /usr/local/bin/envd
          popd
      - name: Generate API docs
        run: |
          pushd envd-docs
          python -m pip install -r hack/api/requirement.txt
          make generate-api-ref
          popd
      - name: Copy API docs to zh docs
        run: |
          pushd envd-docs
          rm -rf docs/zh/api
          cp -r docs/api docs/zh/
          popd
      - name: Generate CLI docs
        run: |
          pushd envd-docs
          make generate-cli-ref
          popd
      - name: Prepare generated changes
        if: ${{ github.event_name == 'schedule' || github.event_name == 'workflow_dispatch' }}
        run: |
          git -C envd-docs add --intent-to-add docs
          git -C envd-docs diff --binary -- docs > api-docs.patch
      - name: Upload generated changes
        if: ${{ github.event_name == 'schedule' || github.event_name == 'workflow_dispatch' }}
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: api-docs-patch
          path: api-docs.patch

  create_pull_request:
    if: ${{ github.event_name == 'schedule' || github.event_name == 'workflow_dispatch' }}
    needs: sync_file
    runs-on: ubuntu-latest
    permissions:
      contents: write
      pull-requests: write
    steps:
      - name: Checkout Envd-docs
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          fetch-depth: 0
          path: envd-docs
          persist-credentials: false
      - name: Download generated changes
        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
        with:
          name: api-docs-patch
      - name: Apply generated changes
        run: git -C envd-docs apply --allow-empty ../api-docs.patch
      - name: Create Pull Request
        uses: peter-evans/create-pull-request@5f6978faf089d4d20b00c7766989d076bb2fc7f1 # v8.1.1
        with:
          path: envd-docs
          add-paths: |
            docs/*
          branch: sync_envd
          title: Auto sync doc with envd repo
          signoff: true