datadog-agent/.github/workflows/docs-dev.yml at 88e6ce06ebc75cad055fc59c79c34f004f627bd4 · DataDog/datadog-agent · 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
name: dev docs

on:
  push:
    branches:
    - main
  pull_request:
    branches:
    - main
    paths:
    - docs/**
    - mkdocs.yml
    - .dda/extend/commands/run/docs/**
    - .dda/extend/pythonpath/utils/docs/**
    - .lychee.toml
    - .go-version
    - .python-version
    - .github/workflows/docs-dev.yml

permissions: {}

concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: ${{ github.event_name == 'pull_request' && true || false }}

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
      with:
        persist-credentials: false
        # Fetch all history for applying timestamps to every page
        fetch-depth: 0

    - name: Install dda
      uses: ./.github/actions/install-dda
      with:
        features: legacy-tasks

    - name: Configure Git for GitHub Actions bot
      run: |
        git config --local user.name 'github-actions[bot]'
        git config --local user.email 'github-actions[bot]@users.noreply.github.com'

    - name: Validate documentation
      run: dda run docs build --check

    - name: Build documentation
      run: dda run docs build

    - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
      with:
        name: documentation
        path: site

  publish:
    runs-on: ubuntu-latest
    permissions:
      contents: write

    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
    needs:
    - build

    steps:
    - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
      with:
        name: documentation
        path: site

    - uses: peaceiris/actions-gh-pages@84c30a85c19949d7eee79c4ff27748b70285e453 # v4.1.0
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_dir: site
        commit_message: ${{ github.event.head_commit.message }}
        # Write .nojekyll at the root, see:
        # https://help.github.com/en/github/working-with-github-pages/about-github-pages#static-site-generators
        enable_jekyll: false
        # Only deploy if there were changes
        allow_empty_commit: false