github-workflows/.github/workflows/docs.yml at main · redis/github-workflows · 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
name: Build and Deploy Documentation

on:
  workflow_call:
    inputs:
      checkout-fetch-depth:
        description: 'Checkout fetch depth. Use 0 to fetch full history for Antora tag/branch discovery.'
        default: '1'
        required: false
        type: string
      checkout-fetch-tags:
        description: 'Whether checkout should fetch tags.'
        default: false
        required: false
        type: boolean
    secrets:
      algolia-app-id:
        required: false
      algolia-api-key:
        required: false
      algolia-index-name:
        required: false
jobs:
  build:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pages: write
      id-token: write
    concurrency:
      group: github-pages
      cancel-in-progress: false
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Checkout repository
        uses: actions/checkout@v6
        with:
          fetch-depth: ${{ inputs.checkout-fetch-depth }}
          fetch-tags: ${{ inputs.checkout-fetch-tags }}
      - name: Configure Pages
        uses: actions/configure-pages@v5
      - name: Build documentation
        uses: redis/github-workflows/.github/actions/build-docs@main
        with:
          algolia-app-id: ${{ secrets.algolia-app-id }}
          algolia-api-key: ${{ secrets.algolia-api-key }}
          algolia-index-name: ${{ secrets.algolia-index-name }}
      - name: Upload Pages artifact
        uses: actions/upload-pages-artifact@v4
        with:
          path: build/site
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4