From f7f5797b8c4011ea8e399cdf4568da82cd3c8ad9 Mon Sep 17 00:00:00 2001 From: Nicola Puppa Date: Sat, 17 Aug 2024 15:42:31 +0200 Subject: [PATCH] feat(rest-api-automation): add workflow to update camunda rest api --- .github/workflows/sync-rest-api-docs.yaml | 54 +++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 .github/workflows/sync-rest-api-docs.yaml diff --git a/.github/workflows/sync-rest-api-docs.yaml b/.github/workflows/sync-rest-api-docs.yaml new file mode 100644 index 00000000000..a25daf65d6a --- /dev/null +++ b/.github/workflows/sync-rest-api-docs.yaml @@ -0,0 +1,54 @@ +name: Sync Camunda REST API + +on: + pull_request: + branches: + - main + schedule: + - cron: "0 16 * * 4" # Runs every Thursday at 4 PM UTC + workflow_dispatch: + +jobs: + sync-file: + runs-on: ubuntu-latest + + steps: + - name: Checkout Camunda docs repository + uses: actions/checkout@v3 + with: + repository: camunda/camunda-docs + + - name: Checkout Camunda repository + uses: actions/checkout@v3 + with: + repository: camunda/camunda + path: camunda-repo + + - name: Sync documentation + run: | + git checkout -b camunda-rest-api-documentation-update + cp camunda-repo/zeebe/gateway-protocol/src/main/proto/rest-api.yaml api/camunda/camunda-openapi.yaml + rm -rf camunda-repo/ + npm i + npm run api:generate:camunda + git config --global user.name "github-actions[bot]" + git config --global user.email "github-actions[bot]@users.noreply.github.com" + if git diff-index --quiet HEAD; then + echo "No changes to commit." + exit 0 + fi + git status + git add api/camunda/camunda-openapi.yaml docs/apis-tools/camunda-api-rest/ + git commit -m "docs(camunda-api): updates camunda rest api documentation" + + - name: Push changes and create PR + run: | + git push --set-upstream origin camunda-rest-api-documentation-update + + - name: Create Pull Request + uses: peter-evans/create-pull-request@v5 + with: + title: "Update camunda REST API" + body: "This PR updates the camunda REST API" + branch: "camunda-rest-api-documentation-update" + base: "main"