Skip to content

docs(readme): update readme #8

docs(readme): update readme

docs(readme): update readme #8

Workflow file for this run

name: "Update Documentation"
on:
push:
branches:
- master
workflow_dispatch:
jobs:
generate:
runs-on: ubuntu-latest
environment: documentation
if: "github.ref == 'refs/heads/master'"
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Generate Documentation
uses: devcontainers/action@v1
with:
base-path-to-templates: "./src"
generate-docs: "true"
- name: Create PR for Documentation
id: push_image_info
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
set -e
echo "START"
# Configure git & push updates
git config --global user.email github-actions@github.com
git config --global user.name github-actions
git config pull.rebase false
branch=automated-documentation-update-$GITHUB_RUN_ID
git checkout -b "$branch"
message='Automated documentation update'
# Add / Update & Commit
git add */**/README.md
git commit -m 'docs(auto): Automated documentation update [skip ci]' || export NO_UPDATES=true
# Push
if [ "$NO_UPDATES" != "true" ]; then
git push origin "$branch"
gh api --method POST \
-H "Accept: application/vnd.github+json" \
/repos/${GITHUB_REPOSITORY}/pulls \
-f title="$message" \
-f body="$message" \
-f head="$branch" \
-f base='main'
fi