spark-connect-ruby/.github/workflows/docs.yml at main · HyukjinKwon/spark-connect-ruby · 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
name: Docs

on:
  push:
    branches: [main]
    paths:
      - "docs/**"
      - "lib/**"
      - ".github/workflows/docs.yml"
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: pages
  cancel-in-progress: false

jobs:
  build:
    name: Build site (Jekyll guides + YARD API)
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7

      - uses: ruby/setup-ruby@v1
        with:
          ruby-version: "3.3"
          # We can't use "bundler-cache: true" here because
          # rubygems-requirements-system isn't triggered when Bundler
          # cache is available.
          # bundler-cache: true

      # Always run "bundle install" manually to trigger
      # rubygems-requirements-system that install Apache Arrow GLib
      # automatically.
      - name: Install dependencies
        run: bundle install

      - name: Build YARD API documentation
        run: bundle exec yard doc --output-dir docs/api

      - uses: actions/configure-pages@v6

      - name: Build Jekyll site
        uses: actions/jekyll-build-pages@v1
        with:
          source: ./docs
          destination: ./_site

      - uses: actions/upload-pages-artifact@v5

  deploy:
    name: Deploy to GitHub Pages
    needs: build
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - id: deployment
        uses: actions/deploy-pages@v5