needle-engine-support/.github/workflows/deploy-docs.yaml at main · needle-tools/needle-engine-support · 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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
name: deploy docs

on:
  # trigger deployment on every push to main branch when docs change
  push:
    branches: [main]
    paths:
      - 'documentation/**'
  repository_dispatch:
    types: [updated_docs]
  discussion:
    types: [created, edited, deleted, labeled, unlabeled, category_changed]
  schedule:
    - cron: '0 0 * * 0' # every Sunday at midnight UTC

concurrency:
  group: 'deploy-docs'
  cancel-in-progress: true

jobs:

  docs:
    # https://github.com/orgs/community/discussions/25641
    # https://github.com/orgs/community/discussions/25389
    # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#discussion
    # https://docs.github.com/en/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion
    if: |
      github.event_name == 'push' ||
      github.event_name == 'repository_dispatch' ||
      (github.event_name == 'discussion' && github.event.discussion.category.name == 'Share')

    runs-on: ubuntu-latest
    timeout-minutes: 15

    steps:
      - uses: actions/checkout@v4
        with:
          # fetch all commits to get last updated time or other git log info
          fetch-depth: 0

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          # choose node.js version to use
          node-version: '20.15'
          cache: 'npm'

      - name: Install dependencies
        run: npm install

      # fetch changelogs from npm
      - name: Build changelogs
        run: npm run docs:build-changelogs

      # run build script
      - name: Build VuePress site
        run: npm run docs:build
        env:
          # @see https://docs.github.com/en/actions/reference/authentication-in-a-workflow#about-the-github_token-secret
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      # deploy to FTP
      - name: Deploy to FTP
        run: npm run docs:deploy
        env:
          # @see https://docs.github.com/en/actions/reference/authentication-in-a-workflow#about-the-github_token-secret
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          FTP_SERVER_NAME: ${{ secrets.FTP_SERVER }}
          FTP_SERVER_USERNAME: "f0152dc5"
          FTP_SERVER_PASSWORD: ${{ secrets.FTP_PASSWORD }}

      # purge Cloudflare cache for docs
      - name: Purge Cloudflare Cache
        if: success()
        run: |
          curl -X POST "https://api.cloudflare.com/client/v4/zones/${{ secrets.CLOUDFLARE_ZONE_ID }}/purge_cache" \
            -H "Authorization: Bearer ${{ secrets.CLOUDFLARE_API_TOKEN }}" \
            -H "Content-Type: application/json" \
            --data '{"prefixes":["engine.needle.tools/docs/"]}'

      # trigger search index crawl
      - name: Trigger Search Crawl
        if: success()
        run: |
          curl -X POST https://search.needle.tools/api/v1/crawl \
            -H "Authorization: Bearer ${{ secrets.NEEDLE_SEARCH_TOKEN }}" \
            -H "Content-Type: application/json" \
            -d '{"source": "6790017a-f836-4195-8247-7e41a2c70bf0"}'


  notify_discord:
    needs: docs
    runs-on: ubuntu-latest
    if: |
      github.event_name == 'push' ||
      github.event_name == 'repository_dispatch'
    steps:
      - uses: tsickert/discord-webhook@v5.3.0
        with:
          webhook-url: ${{ secrets.DEPLOY_DISCORD_WEBHOOK }}
          username: "Deploy Docs 🤖"
          content: "Docs have been updated → <https://engine.needle.tools/docs/>\n`${{ github.event.head_commit.message }}${{github.event.client_payload.reason}}`"

  notify_discord_if_upload_fails:
    needs: docs
    runs-on: ubuntu-latest
    if: |
      failure() &&
      (github.event_name == 'push' || github.event_name == 'repository_dispatch')
    steps:
      - uses: tsickert/discord-webhook@v5.3.0
        with:
          webhook-url: ${{ secrets.DEPLOY_DISCORD_WEBHOOK }}
          username: "Deploy Docs (Error) 🤖"
          content: "Docs have **failed** to update:\n<https://github.com/needle-tools/needle-engine-support/actions/runs/${{ github.run_id }}>\n`${{ github.event.head_commit.message }}${{github.event.client_payload.reason}}`"


  notify_discord_by_contribution:
    needs: docs
    runs-on: ubuntu-latest
    if: |
      (github.event_name == 'discussion' && (github.event.action == 'created' || github.event.action == 'edited') && github.event.discussion.category.name == 'Share')
    steps:
      - uses: tsickert/discord-webhook@v5.3.0
        with:
          webhook-url: ${{ secrets.DEPLOY_DISCORD_WEBHOOK }}
          username: "Deploy Docs (Contribution) 🤖"
          content: "Docs have been updated → <https://engine.needle.tools/docs/community/contributions> by discussion:\n<${{ github.event.discussion.html_url}}>"


  check_links:
    needs: docs
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4
        with:
          # fetch all commits to get last updated time or other git log info
          fetch-depth: 0

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          # choose node.js version to use
          node-version: '20.15'
          cache: 'npm'

      - name: Install dependencies
        run: npm install

      - name: Test Links
        run: npm run test:links
        timeout-minutes: 2
        env:
          DEPLOY_DISCORD_WEBHOOK: ${{ secrets.DEPLOY_DISCORD_WEBHOOK }}