chore: action to generate documentation references (#7888)
Added an action that triggers documentation actions generating references
This commit is contained in:
1 parent
63e64e738a
commit
9b5f26adab
3 files changed
+16
-5
No files matched your search
@@ -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
|
||||||
@@ -1,5 +1,6 @@
|
|||||||
name: Generate Public References
|
name: Generate Public References
|
||||||
on:
|
on:
|
||||||
|
workflow_call:
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
inputs:
|
inputs:
|
||||||
referenceName:
|
referenceName:
|
||||||
@@ -12,7 +13,7 @@ on:
|
|||||||
jobs:
|
jobs:
|
||||||
api-v2:
|
api-v2:
|
||||||
runs-on: ubuntu-latest
|
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:
|
steps:
|
||||||
- name: Cancel Previous Runs
|
- name: Cancel Previous Runs
|
||||||
uses: styfle/cancel-workflow-action@0.11.0
|
uses: styfle/cancel-workflow-action@0.11.0
|
||||||
@@ -62,7 +63,7 @@ jobs:
|
|||||||
branch-suffix: "timestamp"
|
branch-suffix: "timestamp"
|
||||||
ui:
|
ui:
|
||||||
runs-on: ubuntu-latest
|
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:
|
steps:
|
||||||
- name: Cancel Previous Runs
|
- name: Cancel Previous Runs
|
||||||
uses: styfle/cancel-workflow-action@0.11.0
|
uses: styfle/cancel-workflow-action@0.11.0
|
||||||
|
|||||||
@@ -6,6 +6,7 @@ on:
|
|||||||
- develop
|
- develop
|
||||||
types:
|
types:
|
||||||
- closed
|
- closed
|
||||||
|
workflow_call:
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
inputs:
|
inputs:
|
||||||
referenceName:
|
referenceName:
|
||||||
@@ -16,7 +17,7 @@ on:
|
|||||||
jobs:
|
jobs:
|
||||||
references:
|
references:
|
||||||
runs-on: ubuntu-latest
|
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:
|
steps:
|
||||||
- name: Cancel Previous Runs
|
- name: Cancel Previous Runs
|
||||||
uses: styfle/cancel-workflow-action@0.11.0
|
uses: styfle/cancel-workflow-action@0.11.0
|
||||||
@@ -59,12 +60,12 @@ jobs:
|
|||||||
working-directory: www/utils
|
working-directory: www/utils
|
||||||
|
|
||||||
- name: Generate References
|
- 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"
|
run: "yarn start generate ${{ github.event.inputs.referenceName }} --merge"
|
||||||
working-directory: www/utils/packages/typedoc-generate-references
|
working-directory: www/utils/packages/typedoc-generate-references
|
||||||
|
|
||||||
- name: 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"
|
run: "yarn generate:references"
|
||||||
working-directory: www/utils
|
working-directory: www/utils
|
||||||
|
|
||||||
|
|||||||
Reference in new issue
Block a user