documentation-generator-action/examples/with-pull-request.yml at main · DomoApps/documentation-generator-action · 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
# With Pull Request Creation
# Creates a PR with navigation updates for review instead of direct commit

name: Update API Navigation (PR)

on:
  push:
    branches: [main]
    paths:
      - 'yaml/**/*.yaml'
      - 'yaml/**/*.yml'
  workflow_dispatch:  # Allow manual trigger

jobs:
  update-navigation:
    runs-on: ubuntu-latest
    permissions:
      contents: write
      pull-requests: write

    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Generate API Navigation
        uses: DomoApps/documentation-generator-action@main
        with:
          yaml_input_path: './yaml'
          docs_json_path: './docs.json'
          openapi_base_path: 'openapi/product'
          process_changed_only: 'true'
          create_pull_request: 'true'
          pr_title: 'docs: Update API navigation'
          pr_branch_name: 'docs/api-navigation-update'