Merge pull request #279 from Trackunit/update-api-overviews #312
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Sync `api-docs` directory to ReadMe | |
| # Run workflow for every push to the `main` branch | |
| on: | |
| push: | |
| branches: | |
| - master | |
| 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: Sync API docs | |
| # 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 ./api-docs --key=${{ secrets.README_API_KEY }} --version=1.0 | |
| # Run GitHub Action to sync docs in `documentation` directory | |
| - name: Sync Guides | |
| # 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 ./guides --key=${{ secrets.README_API_KEY }} --version=1.0 | |
| # Run GitHub Action to sync docs in `documentation` directory | |
| - name: Sync custom pages docs | |
| # 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: custompages ./custompages --key=${{ secrets.README_API_KEY }} | |
| # Run GitHub Action to sync changelogs in `changelog` directory | |
| - name: Sync changelog pages docs | |
| # 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: changelogs ./changelogs --key=${{ secrets.README_API_KEY }} |