docs/.github/workflows/docs.yml at main · DependencyTrack/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
# This file is part of Dependency-Track.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0
# Copyright (c) OWASP Foundation. All Rights Reserved.
name: docs

on:
  push:
    branches: [main]
    tags: ["[0-9]+.[0-9]+.[0-9]+", "[0-9]+.[0-9]+.[0-9]+-*"]
  pull_request:
    branches: [main]

permissions: {}

jobs:
  lint:
    runs-on: ubuntu-latest
    if: github.event_name == 'pull_request'
    steps:
    - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      with:
        persist-credentials: false
    - name: Install imaging dependencies
      run: >-
        sudo apt-get install -y --no-install-recommends
        libcairo2-dev libfreetype6-dev libffi-dev
        libjpeg-dev libpng-dev libz-dev
    - uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
      with:
        enable-cache: false
    - name: Lint Markdown
      run: make lint-markdown
    - name: Lint YAML
      run: make lint-yaml
    - name: Lint prose
      run: make lint-prose
    - name: Lint Python
      run: make lint-python
    - name: Build
      run: make build

  deploy:
    runs-on: ubuntu-latest
    if: github.event_name == 'push'
    permissions:
      contents: write
    steps:
    - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      with:
        fetch-depth: 0
        persist-credentials: false
    - name: Configure git
      run: |
        git config user.name  "github-actions[bot]"
        git config user.email "github-actions[bot]@users.noreply.github.com"
        git remote set-url origin "https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git"
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    - name: Install imaging dependencies
      run: >-
        sudo apt-get install -y --no-install-recommends
        libcairo2-dev libfreetype6-dev libffi-dev
        libjpeg-dev libpng-dev libz-dev
    - uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
      with:
        enable-cache: false
    - name: Lint
      run: make lint
    - name: Deploy next
      if: github.ref == 'refs/heads/main'
      run: uv run mike deploy --push next
    - name: Deploy release
      if: startsWith(github.ref, 'refs/tags/')
      run: |
        TAG="${GITHUB_REF#refs/tags/}"
        if [[ "$TAG" == *-* ]]; then
          uv run mike deploy --push "$TAG"
        else
          MINOR="${TAG%.*}"
          uv run mike deploy --push --update-aliases "$MINOR" latest
          uv run mike set-default --push latest
        fi