From cd0ac39c396b433a2f0a25f72d08e7dbf0bd6943 Mon Sep 17 00:00:00 2001 From: Joao Pedro Truchinski Borba Date: Sat, 6 Apr 2024 18:47:38 -0300 Subject: [PATCH] feat: documentation workflow --- .github/workflows/documentation.yml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .github/workflows/documentation.yml diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 0000000..33cde6e --- /dev/null +++ b/.github/workflows/documentation.yml @@ -0,0 +1,22 @@ +name: Sync `documentation` directory to ReadMe + +# Run workflow for every push to the `main` branch +on: + push: + branches: + - main + +jobs: + sync: + runs-on: ubuntu-latest + steps: + - name: Checkout this repo + uses: actions/checkout@v3 + + # Run GitHub Action to sync docs in `documentation` directory + - name: GitHub Action + # We recommend specifying a fixed version, i.e. @v8 + # Docs: https://docs.github.com/actions/using-workflows/workflow-syntax-for-github-actions#example-using-versioned-actions + uses: readmeio/rdme@v8 + with: + rdme: docs ./documentation --key=${{ secrets.README_API_KEY }} --version=2.0 \ No newline at end of file