diff --git a/.github/workflows/sync.yml b/.github/workflows/sync.yml index 45b520c..cd70ac6 100644 --- a/.github/workflows/sync.yml +++ b/.github/workflows/sync.yml @@ -1,22 +1,23 @@ -name: Sync OpenAPI definition to ReadMe +# This GitHub Actions workflow was auto-generated by the `rdme` cli on 2024-07-24T13:04:54.653Z +# You can view our full documentation here: https://docs.readme.com/docs/rdme +name: ReadMe GitHub Action 🦉 -# Run workflow for every push to the `main` branch on: push: branches: + # This workflow will run every time you push code to the following branch: `main` + # Check out GitHub's docs for more info on configuring this: + # https://docs.github.com/actions/using-workflows/events-that-trigger-workflows - main jobs: - sync: + rdme-openapi: runs-on: ubuntu-latest steps: - - name: Checkout this repo - uses: actions/checkout@v4 + - name: Check out repo 📚 + uses: actions/checkout@v3 - # Run GitHub Action to sync OpenAPI file at ./path-to-file.json - - 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: openapi src/test/resources/openapi.yaml --key=${{ secrets.README_API_KEY }} --id=${{ secrets.API_DEFINITION_ID }} \ No newline at end of file + - name: Run `openapi` command 🚀 + uses: readmeio/rdme@v8 + with: + rdme: openapi src/test/resources/openapi.yaml --key=${{ secrets.README_API_KEY }} --id=${{ secrets.API_DEFINITION_ID }} \ No newline at end of file