reusable-workflows/.github/workflows/deploy-github-pages.yaml at main · devantler-tech/reusable-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
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
name: 🚀 Deploy GitHub Pages

on:
  workflow_call:
    inputs:
      dry-run:
        description: "Skip build and deploy (validate workflow interface only)"
        required: false
        default: false
        type: boolean
      ruby-version:
        description: Ruby version to setup
        required: false
        default: "3.3"
        type: string
      jekyll-env:
        description: Jekyll environment
        required: false
        default: production
        type: string
      extra-build-args:
        description: Extra arguments appended to the Jekyll build command (before --baseurl)
        required: false
        default: ""
        type: string
      working-directory:
        description: Working directory for the Jekyll site (e.g., 'docs' if the site is in a subdirectory)
        required: false
        default: "."
        type: string
    outputs:
      page-url:
        description: Deployed GitHub Pages URL
        value: ${{ jobs.deploy.outputs.page-url }}

permissions: {}

jobs:
  build:
    name: Build Site
    if: ${{ !inputs.dry-run }}
    permissions:
      contents: read
      pages: write
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          persist-credentials: false
      - name: Setup Ruby
        uses: ruby/setup-ruby@c4e5b1316158f92e3d49443a9d58b31d25ac0f8f # v1.306.0
        with:
          ruby-version: ${{ inputs.ruby-version }}
          bundler-cache: true
          cache-version: 0
          working-directory: ${{ inputs.working-directory }}
      - name: Setup Pages
        id: pages
        uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6.0.0
      - name: Build with Jekyll
        env:
          JEKYLL_ENV: ${{ inputs.jekyll-env }}
          EXTRA_BUILD_ARGS: ${{ inputs.extra-build-args }}
          BASE_PATH: ${{ steps.pages.outputs.base_path }}
        working-directory: ${{ inputs.working-directory }}
        run: |
          read -ra extra_args <<< "$EXTRA_BUILD_ARGS"
          bundle exec jekyll build "${extra_args[@]}" --baseurl "$BASE_PATH"
      - name: Upload artifact
        uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
        with:
          path: ${{ inputs.working-directory }}/_site

  deploy:
    name: Deploy Site
    if: ${{ !inputs.dry-run }}
    runs-on: ubuntu-latest
    needs: build
    permissions:
      pages: write
      id-token: write
    outputs:
      page-url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0