respec.yaml

name: respec

# author: @frankkilcommins (inspired by work from @MikeRalphson)

#
# This workflow updates the respec 'pretty' rendered versions of the spec 
# on the gh-pages branch when the corresponding markdown files change.
#

# run this on push to main
on:
  push:
    paths:
      - 'versions/**'
    branches:
      - main

  workflow_dispatch: {}

jobs:
  respec:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v2 # checkout main branch
      with:
        fetch-depth: 0

    - name: Install dependencies
      run: npm i

    - uses: actions/checkout@v2 # checkout gh-pages branch
      with:
        token: ${{ secrets.OAS_REPO_TOKEN }}
        repository: OAI/OpenAPI-Specification  
        ref: gh-pages
        path: deploy

    - name: run main script
      run: scripts/md2html/build.sh

  # need to create a pull request against a reomte repository here 
  # to update the gh-pages branch on the OAI repo
    - name: Create Pull Request
      uses: peter-evans/create-pull-request@v5
      with:
        token: ${{ secrets.OAS_REPO_TOKEN }}
        branch: update-respec-version
        base: gh-pages
        delete-branch: true
        path: deploy
        labels: Housekeeping
        title: Update ReSpec versions for Arazzo
        commit-message: Update ReSpec versions
        signoff: true
        body: |
          This pull request is automatically triggered by GitHub action `respec`.

          The versions/v*.md files of the Arazzo Specification have changed, so the HTML files are automatically being regenerated.