From 863e52d6527cef7e260036b4e4327197a804a9bd Mon Sep 17 00:00:00 2001 From: DriesSchaumont <5946712+DriesSchaumont@users.noreply.github.com> Date: Wed, 23 Apr 2025 07:06:55 +0000 Subject: [PATCH 1/6] Add documentation render to integration test CI --- .github/workflows/integration-test.yml | 30 ++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/.github/workflows/integration-test.yml b/.github/workflows/integration-test.yml index a2fc447e58e..f3987199959 100644 --- a/.github/workflows/integration-test.yml +++ b/.github/workflows/integration-test.yml @@ -25,6 +25,36 @@ jobs: deploy_branch: 'integration_build' secrets: inherit + documentation_render_check: + # Check if the documentation renders but do not publish + runs-on: ubuntu-latest + steps: + - uses: viash-io/viash-actions/pro/generate-documentation-qmd@v6 + with: + project_directory: openpipelines + src: src + query: '^(?!workflows|test_workflows)' + output_dir: ../website/components/modules/ + dest_path: "{namespace}/{name}.qmd" + viash_pro_token: ${{ secrets.GTHB_PAT }} + tools_version: main_build + ref: "${{ steps.get_tag.outputs.tag }}" + clean: true + + + - uses: viash-io/viash-actions/pro/generate-documentation-qmd@v6 + with: + project_directory: openpipelines + src: src + query: '^workflows' + output_dir: ../website/components/ + dest_path: "{namespace}/{name}.qmd" + viash_pro_token: ${{ secrets.GTHB_PAT }} + tools_version: main_build + ref: "${{ steps.get_tag.outputs.tag }}" + clean: true + + # Synchronize S3 Bucket and create cache for per-component runs sync_s3: env: From c95037e33b7f74cef8e7e317d4c2ce0244d59aeb Mon Sep 17 00:00:00 2001 From: DriesSchaumont <5946712+DriesSchaumont@users.noreply.github.com> Date: Wed, 23 Apr 2025 07:16:31 +0000 Subject: [PATCH 2/6] Add name and add to execution tree --- .github/workflows/integration-test.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/integration-test.yml b/.github/workflows/integration-test.yml index f3987199959..3d425de4294 100644 --- a/.github/workflows/integration-test.yml +++ b/.github/workflows/integration-test.yml @@ -26,6 +26,7 @@ jobs: secrets: inherit documentation_render_check: + name: "Check if documentation renders" # Check if the documentation renders but do not publish runs-on: ubuntu-latest steps: @@ -76,7 +77,7 @@ jobs: # phase 3 integration_test: runs-on: ubuntu-latest - needs: [ build, sync_s3 ] + needs: [ build, sync_s3, documentation_render_check ] if: "${{ needs.build.outputs.workflow_matrix != '[]' }}" strategy: From e35e1e25dbba88ea134ad6ed1e7bc59ff311bbbd Mon Sep 17 00:00:00 2001 From: DriesSchaumont <5946712+DriesSchaumont@users.noreply.github.com> Date: Wed, 23 Apr 2025 07:28:11 +0000 Subject: [PATCH 3/6] Add checkout --- .github/workflows/integration-test.yml | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/.github/workflows/integration-test.yml b/.github/workflows/integration-test.yml index 3d425de4294..90f43170c1d 100644 --- a/.github/workflows/integration-test.yml +++ b/.github/workflows/integration-test.yml @@ -30,6 +30,16 @@ jobs: # Check if the documentation renders but do not publish runs-on: ubuntu-latest steps: + - uses: actions/checkout@v4 + with: + path: openpipelines + + - uses: actions/checkout@v4 + with: + repository: openpipelines-bio/website + path: website + token: ${{ secrets.GTHB_PAT }} + - uses: viash-io/viash-actions/pro/generate-documentation-qmd@v6 with: project_directory: openpipelines @@ -39,7 +49,7 @@ jobs: dest_path: "{namespace}/{name}.qmd" viash_pro_token: ${{ secrets.GTHB_PAT }} tools_version: main_build - ref: "${{ steps.get_tag.outputs.tag }}" + ref: "integration_build" clean: true @@ -52,7 +62,7 @@ jobs: dest_path: "{namespace}/{name}.qmd" viash_pro_token: ${{ secrets.GTHB_PAT }} tools_version: main_build - ref: "${{ steps.get_tag.outputs.tag }}" + ref: "integration_build" clean: true From c01b9a4232ba9ae2c9b0503cb37f5403ed14d6d8 Mon Sep 17 00:00:00 2001 From: DriesSchaumont <5946712+DriesSchaumont@users.noreply.github.com> Date: Wed, 23 Apr 2025 07:33:47 +0000 Subject: [PATCH 4/6] Remove deprecated argument and move needs --- .github/workflows/create-documentation-pr.yml | 2 -- .github/workflows/integration-test.yml | 5 ++--- 2 files changed, 2 insertions(+), 5 deletions(-) diff --git a/.github/workflows/create-documentation-pr.yml b/.github/workflows/create-documentation-pr.yml index d18fc88d476..989d3311c60 100644 --- a/.github/workflows/create-documentation-pr.yml +++ b/.github/workflows/create-documentation-pr.yml @@ -39,7 +39,6 @@ jobs: - uses: viash-io/viash-actions/pro/generate-documentation-qmd@v6 with: project_directory: openpipelines - src: src query: '^(?!workflows|test_workflows)' output_dir: ../website/components/modules/ dest_path: "{namespace}/{name}.qmd" @@ -52,7 +51,6 @@ jobs: - uses: viash-io/viash-actions/pro/generate-documentation-qmd@v6 with: project_directory: openpipelines - src: src query: '^workflows' output_dir: ../website/components/ dest_path: "{namespace}/{name}.qmd" diff --git a/.github/workflows/integration-test.yml b/.github/workflows/integration-test.yml index 90f43170c1d..d47ad7dfab5 100644 --- a/.github/workflows/integration-test.yml +++ b/.github/workflows/integration-test.yml @@ -18,6 +18,7 @@ jobs: # Build and create containers build: uses: ./.github/workflows/main-build.yml + needs: [documentation_render_check] with: push_containers: ${{ github.event_name == 'schedule' || inputs.push_containers }} version: 'integration_build' @@ -43,7 +44,6 @@ jobs: - uses: viash-io/viash-actions/pro/generate-documentation-qmd@v6 with: project_directory: openpipelines - src: src query: '^(?!workflows|test_workflows)' output_dir: ../website/components/modules/ dest_path: "{namespace}/{name}.qmd" @@ -56,7 +56,6 @@ jobs: - uses: viash-io/viash-actions/pro/generate-documentation-qmd@v6 with: project_directory: openpipelines - src: src query: '^workflows' output_dir: ../website/components/ dest_path: "{namespace}/{name}.qmd" @@ -87,7 +86,7 @@ jobs: # phase 3 integration_test: runs-on: ubuntu-latest - needs: [ build, sync_s3, documentation_render_check ] + needs: [ build, sync_s3 ] if: "${{ needs.build.outputs.workflow_matrix != '[]' }}" strategy: From d5ec7c7ab5ec5ed4bec46dc2b5727abbc944103d Mon Sep 17 00:00:00 2001 From: DriesSchaumont <5946712+DriesSchaumont@users.noreply.github.com> Date: Wed, 23 Apr 2025 07:42:10 +0000 Subject: [PATCH 5/6] Rendering documentation requires target folder --- .github/workflows/integration-test.yml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/integration-test.yml b/.github/workflows/integration-test.yml index d47ad7dfab5..f8a7eacaa30 100644 --- a/.github/workflows/integration-test.yml +++ b/.github/workflows/integration-test.yml @@ -18,7 +18,6 @@ jobs: # Build and create containers build: uses: ./.github/workflows/main-build.yml - needs: [documentation_render_check] with: push_containers: ${{ github.event_name == 'schedule' || inputs.push_containers }} version: 'integration_build' @@ -27,12 +26,14 @@ jobs: secrets: inherit documentation_render_check: + needs: ["build"] name: "Check if documentation renders" # Check if the documentation renders but do not publish runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 with: + ref: integration_build path: openpipelines - uses: actions/checkout@v4 @@ -86,7 +87,7 @@ jobs: # phase 3 integration_test: runs-on: ubuntu-latest - needs: [ build, sync_s3 ] + needs: [ sync_s3, documentation_render_check ] if: "${{ needs.build.outputs.workflow_matrix != '[]' }}" strategy: From 8c48dc6227b16d8e3b3a535a2fc20cbb29a42e96 Mon Sep 17 00:00:00 2001 From: DriesSchaumont <5946712+DriesSchaumont@users.noreply.github.com> Date: Wed, 23 Apr 2025 08:18:21 +0000 Subject: [PATCH 6/6] Fix needs --- .github/workflows/integration-test.yml | 43 +------------------------- 1 file changed, 1 insertion(+), 42 deletions(-) diff --git a/.github/workflows/integration-test.yml b/.github/workflows/integration-test.yml index f8a7eacaa30..c223de33c0e 100644 --- a/.github/workflows/integration-test.yml +++ b/.github/workflows/integration-test.yml @@ -25,47 +25,6 @@ jobs: deploy_branch: 'integration_build' secrets: inherit - documentation_render_check: - needs: ["build"] - name: "Check if documentation renders" - # Check if the documentation renders but do not publish - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - with: - ref: integration_build - path: openpipelines - - - uses: actions/checkout@v4 - with: - repository: openpipelines-bio/website - path: website - token: ${{ secrets.GTHB_PAT }} - - - uses: viash-io/viash-actions/pro/generate-documentation-qmd@v6 - with: - project_directory: openpipelines - query: '^(?!workflows|test_workflows)' - output_dir: ../website/components/modules/ - dest_path: "{namespace}/{name}.qmd" - viash_pro_token: ${{ secrets.GTHB_PAT }} - tools_version: main_build - ref: "integration_build" - clean: true - - - - uses: viash-io/viash-actions/pro/generate-documentation-qmd@v6 - with: - project_directory: openpipelines - query: '^workflows' - output_dir: ../website/components/ - dest_path: "{namespace}/{name}.qmd" - viash_pro_token: ${{ secrets.GTHB_PAT }} - tools_version: main_build - ref: "integration_build" - clean: true - - # Synchronize S3 Bucket and create cache for per-component runs sync_s3: env: @@ -87,7 +46,7 @@ jobs: # phase 3 integration_test: runs-on: ubuntu-latest - needs: [ sync_s3, documentation_render_check ] + needs: [ sync_s3, build, documentation_render_check ] if: "${{ needs.build.outputs.workflow_matrix != '[]' }}" strategy: