docs-workshop/.github/workflows/CI.yml at main · joshooaj/docs-workshop · 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
name: Test

on:
  workflow_dispatch:
  push:
    tags:
      - v*
    branches:
      - main
    paths-ignore:
      - .github/workflows/Docs.yml
      - docs/**
  pull_request:
    branches:
      - main
    paths-ignore:
      - .github/workflows/Docs.yml
      - docs/**

jobs:
  build:
    name: Build
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: true
      matrix:
        os: [ubuntu-latest, windows-latest, macOS-latest]
    steps:

      # Setting fetch-depth to 0 helps when using mkdocs plugins like
      # git-revision-date-localized to add create/edit dates to pages automatically.
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0

      # Using caches in a larger project can really speed up builds
      - uses: actions/cache@v4
        with:
          key: ${{ runner.os }}-mkdocs
          path: .cache

      - name: Test
        shell: pwsh
        run: ./build.ps1 -Task Test -Bootstrap

      - uses: actions/upload-artifact@v4
        with:
          name: module
          path: ./Output/

          # The desired behavior if no files are found using the provided path.
          # Available Options:
          #   warn: Output a warning but do not fail the action
          #   error: Fail the action with an error message
          #   ignore: Do not output any warnings or errors, the action does not fail
          # Optional. Default is 'warn'
          if-no-files-found: error

          # Duration after which artifact will expire in days. 0 means using default retention.
          # Minimum 1 day.
          # Maximum 90 days unless changed from the repository settings page.
          # Optional. Defaults to repository settings.
          retention-days: 1

          # The level of compression for Zlib to be applied to the artifact archive.
          # The value can range from 0 to 9.
          # For large files that are not easily compressed, a value of 0 is recommended for significantly faster uploads.
          # Optional. Default is '6'
          compression-level: 6

          # If true, an artifact with a matching name will be deleted before a new one is uploaded.
          # If false, the action will fail if an artifact for the given name already exists.
          # Does not fail if the artifact does not exist.
          # Optional. Default is 'false'
          overwrite: true