update-documentation.yml

name: "Update Documentation"
on:
  push:
    branches:
      - main
      - arausell/docs-pr-auth
  workflow_dispatch:

jobs:
  generate:
    runs-on: ubuntu-latest
    environment: documentation
    permissions:
      contents: write
      pull-requests: write
    if: "github.ref == 'refs/heads/main'"
    steps:
      - uses: actions/checkout@v4

      - name: Generate Documentation
        uses: devcontainers/action@v1
        with:
          generate-docs: "true"
          base-path-to-features: "./src"

      - name: Create Pull Request for Documentation
        uses: peter-evans/create-pull-request@v6
        with:
          app-id: ${{ secrets.DEVCONTAINERS_APP_ID }}
          private-key: ${{ secrets.DEVCONTAINERS_APP_CLIENT_SECRET }}
          commit-message: Automated documentation update [skip ci]
          title: Automated documentation update
          body: |
            Automated documentation update by the Devcontainers app.
            This PR includes updates to README.md files generated by the workflow.
          branch: automated-documentation-update-${{ github.run_id }}
          base: main