From 9b5f26adab7007f6720ec6254b628fd8b3469e1b Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Mon, 1 Jul 2024 16:54:17 +0300 Subject: [PATCH] chore: action to generate documentation references (#7888) Added an action that triggers documentation actions generating references --- .github/workflows/generate-preview-references.yml | 9 +++++++++ .github/workflows/generate-public-references.yml | 5 +++-- .github/workflows/generate-resources-reference.yml | 7 ++++--- 3 files changed, 16 insertions(+), 5 deletions(-) create mode 100644 .github/workflows/generate-preview-references.yml diff --git a/.github/workflows/generate-preview-references.yml b/.github/workflows/generate-preview-references.yml new file mode 100644 index 0000000000..b70ea0d658 --- /dev/null +++ b/.github/workflows/generate-preview-references.yml @@ -0,0 +1,9 @@ +name: Generate Preview Reference [Automated] +on: + schedule: + - cron: "0 0 * * *" +jobs: + preview-references: + uses: ./.github/workflows/generate-resources-reference.yml + preview-api-ui: + uses: ./.github/workflows/generate-public-references.yml \ No newline at end of file diff --git a/.github/workflows/generate-public-references.yml b/.github/workflows/generate-public-references.yml index 5d0787a877..205b4129c3 100644 --- a/.github/workflows/generate-public-references.yml +++ b/.github/workflows/generate-public-references.yml @@ -1,5 +1,6 @@ name: Generate Public References on: + workflow_call: workflow_dispatch: inputs: referenceName: @@ -12,7 +13,7 @@ on: jobs: api-v2: runs-on: ubuntu-latest - if: ${{ github.event_name == 'release' || github.event.inputs.referenceName == 'all' || github.event.inputs.referenceName == 'api' }} + if: ${{ github.event_name == 'release' || github.event_name == 'workflow_call' || github.event.inputs.referenceName == 'all' || github.event.inputs.referenceName == 'api' }} steps: - name: Cancel Previous Runs uses: styfle/cancel-workflow-action@0.11.0 @@ -62,7 +63,7 @@ jobs: branch-suffix: "timestamp" ui: runs-on: ubuntu-latest - if: ${{ github.event_name == 'release' || github.event.inputs.referenceName == 'all' || github.event.inputs.referenceName == 'ui' }} + if: ${{ github.event_name == 'release' || github.event_name == 'workflow_call' || github.event.inputs.referenceName == 'all' || github.event.inputs.referenceName == 'ui' }} steps: - name: Cancel Previous Runs uses: styfle/cancel-workflow-action@0.11.0 diff --git a/.github/workflows/generate-resources-reference.yml b/.github/workflows/generate-resources-reference.yml index 0dfddda812..77111293d1 100644 --- a/.github/workflows/generate-resources-reference.yml +++ b/.github/workflows/generate-resources-reference.yml @@ -6,6 +6,7 @@ on: - develop types: - closed + workflow_call: workflow_dispatch: inputs: referenceName: @@ -16,7 +17,7 @@ on: jobs: references: runs-on: ubuntu-latest - if: github.event_name == 'workflow_dispatch' || (startsWith(github.head_ref, 'chore/generate-tsdocs') && github.event.pull_request.merged == true) + if: github.event_name == 'workflow_dispatch' || github.event_name == 'workflow_call' || (startsWith(github.head_ref, 'chore/generate-tsdocs') && github.event.pull_request.merged == true) steps: - name: Cancel Previous Runs uses: styfle/cancel-workflow-action@0.11.0 @@ -59,12 +60,12 @@ jobs: working-directory: www/utils - name: Generate References - if: ${{ github.event_name == 'workflow_dispatch' }} + if: ${{ github.event_name == 'workflow_dispatch' || github.event_name == 'workflow_call' }} run: "yarn start generate ${{ github.event.inputs.referenceName }} --merge" working-directory: www/utils/packages/typedoc-generate-references - name: Generate References - if: ${{ github.event_name != 'workflow_dispatch' }} + if: ${{ github.event_name != 'workflow_dispatch' || github.event_name == 'workflow_call' }} run: "yarn generate:references" working-directory: www/utils