release.yml

name: Release

on:
  workflow_dispatch:
  push:
    branches: [ main ]
    paths: [ src/** ]

defaults:
  run:
    shell: bash

permissions:
  contents: read
  packages: write

jobs:
  deploy:
    if: ${{ github.ref == 'refs/heads/main' }}
    runs-on: ubuntu-22.04
    permissions:
      contents: write
      pull-requests: write
      packages: write
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Publish Features
        uses: devcontainers/action@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          publish-features: 'true'
          base-path-to-features: ./src
          generate-docs: 'true'

      - name: Create PR for Documentation
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          set -eE -o pipefail
          shopt -s inherit_errexit

          echo "Setting up git"
          git config --global user.email github-actions[bot]@users.noreply.github.com
          git config --global user.name github-actions[bot]
          git config pull.rebase false

          echo "Creating new branch"
          BRANCH=automated-documentation-update-${GITHUB_RUN_ID}
          git checkout -b "${BRANCH}"

          echo "Commiting changes"
          git add */**/README.md
          if git commit -m 'Automated documentation update [skip ci]'; then
            echo "Changes committed"
            echo "Pushing changes to remote"
            git push origin "${BRANCH}"
            MESSAGE='Automated documentation update'
            echo "Creating pull request"
            gh pr create --title "${MESSAGE}" --body "${MESSAGE}"
          else
            echo "No changes present - nothing to commit and push"
          fi