api-doc.yml

name: 📚 OpenAPI Documentation

on:
  pull_request:
    branches:
      - main
      - develop
    paths:
      - 'openapi.yaml'

jobs:

  generate-documentation:
    runs-on: ubuntu-latest
    
    permissions:
      contents: write
      packages: write
      attestations: write
      id-token: write
    
    steps:
    - name: Checkout ⬇️
      uses: actions/checkout@v4.2.2
      with:
          show-progress: false

    - name: 📥 Generate OpenAPI Documentation
      run: |
        npm install -g openapi-to-md
        npx openapi-to-md -s openapi.yaml openapi.md
        
    - name: 📤 Commit changes
      uses: actions-js/push@master
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        force: true
        files: openapi.md
        message: 'docs(api): updated openapi.md 📝'
        branch: ${{ github.head_ref }}