docs/.github/workflows/docs-linkcheck.yaml at main · MIDOSS/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
name: sphinx-linkcheck

on:
  push:
    branches:
    - '*'
  pull_request:
    branches:
    - '*'
  schedule:
    - cron: 43 4 3 * *  # 04:43 UTC on the 3rd day of each month
  # Enable workflow to be triggered from GitHub CLI, browser, or via API
  workflow_dispatch:

jobs:
  sphinx-linkcheck:
    name: linkcheck
    runs-on: 'ubuntu-latest'
    strategy:
      fail-fast: false
      matrix:
        python-version: ['3.8']

    steps:
      - uses: actions/checkout@v2

      - name: Cache conda pkgs
        uses: actions/cache@v1
        env:
          # Increase this value to reset cache if envs/environment-test.yaml has not changed
          CACHE_NUMBER: 0
        with:
          path: ~/conda_pkgs_dir
          key: ${{ runner.os }}-conda-${{ env.CACHE_NUMBER }}-${{ hashFiles('environment.yaml') }}

      - uses: conda-incubator/setup-miniconda@v2
        with:
           auto-update-conda: false
           auto-activate-base: false
           use-only-tar-bz2: true # Required for caching to work properly!
           environment-file: environment.yaml
           python-version: ${{ matrix.python-version }}
           activate-environment: midoss-docs

      - name: linkcheck
        shell: bash -l {0}
        run: |
          make linkcheck

      - uses: 8398a7/action-slack@v3
        with:
          status: ${{ job.status }}
          author_name: Sphinx linkcheck
          fields: repo,eventName,ref,workflow
        env:
          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
        if: always()