zinit/.github/workflows/documentation.yaml at main · zdharma-continuum/zinit · 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
name: Documentation

on:
  pull_request:
    branches:
      - main
    paths:
      - 'zinit*.zsh'
  push:
    branches:
      - main
    paths:
      - 'zinit*.zsh'
  workflow_dispatch:

jobs:
  zshelldoc:
    runs-on: ubuntu-latest
    steps:

      - name: checkout repository
        uses: actions/checkout@v6
        with:
          repository: ${{ github.event.pull_request.head.repo.full_name || github.repository }}
          ref: ${{ github.event.pull_request.head.ref || github.ref }}

      - name: re-generate documentation
        run: |
          make doc/container
          sudo chown -R "$(id -u):$(id -g)" .

      - name: commit and push updated docs
        if: github.event_name != 'pull_request'
        uses: EndBug/add-and-commit@v9
        with:
          add: 'doc'
          author_name: GitHub Actions
          author_email: [email protected]
          commit: --signoff
          message: 'docs: generate'
          push: true