Skip to content

Stage reference changes to readme #21

Stage reference changes to readme

Stage reference changes to readme #21

name: Generate ReadMe Staging πŸ¦‰
on:
# when a PR is created in any branch except main that have made changes to the
# reference folder, run this workflow
push:
branches-ignore:
- main
pull_request:
paths:
- 'reference/**'
jobs:
# ////////////////////////////////////////////////////////////////////////
# Pull Request
# ////////////////////////////////////////////////////////////////////////
# Create a new ReadMe Version if it needs to
rdme-version:
runs-on: ubuntu-latest
steps:
- name: Check out repo πŸ“š
uses: actions/checkout@v3
- name: Check if the readme version exists
id: has-readme-version
run: |
if rdme versions --version=${{ github.event.pull_request.number }}; then
echo "::set-output name=result_exists::true"
else
echo "::set-output name=result_exists::false"
fi
- name: Run create readme version
if: steps.has-readme-version.outputs.result_exists == 'false'
uses: readmeio/rdme@v8
with:
rdme: versions:create ${{ github.event.pull_request.number }} --key=${{ secrets.README_API_KEY }} --fork=v3.26 --main=false --beta=false --deprecated=false --isPublic=true
# Push branch content onto that ReadMe Version
rdme-docs:
runs-on: ubuntu-latest
needs:
- rdme-version
steps:
- name: Check out repo πŸ“š
uses: actions/checkout@v3
- name: Run `docs` command πŸš€
uses: readmeio/rdme@v8
with:
rdme: docs ./reference --key=${{ secrets.README_API_KEY }} --version=${{ github.event.pull_request.number }}