update docstrings #6502
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: pr | |
| on: | |
| push: | |
| branches: | |
| - "pull-request/[0-9]+" | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| # Please keep pr-builder as the top job here | |
| pr-builder: | |
| needs: | |
| - changed-files | |
| - checks | |
| - conda-cpp-build | |
| - conda-cpp-tests | |
| - conda-cpp-checks | |
| - conda-notebook-tests | |
| - conda-python-build | |
| - conda-python-tests | |
| - docs-build | |
| - wheel-build-pylibcugraph | |
| - wheel-tests-pylibcugraph | |
| - wheel-build-cugraph | |
| - wheel-tests-cugraph | |
| - telemetry-setup | |
| - devcontainer | |
| secrets: inherit | |
| uses: rapidsai/shared-workflows/.github/workflows/[email protected] | |
| if: always() | |
| with: | |
| needs: ${{ toJSON(needs) }} | |
| telemetry-setup: | |
| runs-on: ubuntu-latest | |
| continue-on-error: true | |
| env: | |
| OTEL_SERVICE_NAME: "pr-cugraph" | |
| steps: | |
| - name: Telemetry setup | |
| uses: rapidsai/shared-actions/telemetry-dispatch-stash-base-env-vars@main | |
| changed-files: | |
| secrets: inherit | |
| needs: telemetry-setup | |
| uses: rapidsai/shared-workflows/.github/workflows/[email protected] | |
| with: | |
| files_yaml: | | |
| test_cpp: | |
| - '**' | |
| - '!.devcontainers/**' | |
| - '!CONTRIBUTING.md' | |
| - '!README.md' | |
| - '!docs/**' | |
| - '!img/**' | |
| - '!mg_utils/**' | |
| - '!notebooks/**' | |
| - '!python/**' | |
| - '!readme_pages/**' | |
| test_notebooks: | |
| - '**' | |
| - '!.devcontainers/**' | |
| - '!CONTRIBUTING.md' | |
| - '!README.md' | |
| - '!docs/**' | |
| test_python: | |
| - '**' | |
| - '!.devcontainers/**' | |
| - '!CONTRIBUTING.md' | |
| - '!README.md' | |
| - '!docs/**' | |
| - '!img/**' | |
| - '!notebooks/**' | |
| checks: | |
| secrets: inherit | |
| needs: telemetry-setup | |
| uses: rapidsai/shared-workflows/.github/workflows/[email protected] | |
| with: | |
| enable_check_generated_files: false | |
| ignored_pr_jobs: telemetry-summarize | |
| conda-cpp-build: | |
| needs: checks | |
| secrets: inherit | |
| uses: rapidsai/shared-workflows/.github/workflows/[email protected] | |
| with: | |
| build_type: pull-request | |
| node_type: cpu32 | |
| conda-cpp-tests: | |
| needs: [conda-cpp-build, changed-files] | |
| secrets: inherit | |
| uses: rapidsai/shared-workflows/.github/workflows/[email protected] | |
| if: fromJSON(needs.changed-files.outputs.changed_file_groups).test_cpp | |
| with: | |
| build_type: pull-request | |
| conda-cpp-checks: | |
| needs: conda-cpp-build | |
| secrets: inherit | |
| uses: rapidsai/shared-workflows/.github/workflows/[email protected] | |
| with: | |
| build_type: pull-request | |
| enable_check_symbols: true | |
| symbol_exclusions: (cugraph::ops|hornet|void writeEdgeCountsKernel|void markUniqueOffsetsKernel) | |
| conda-python-build: | |
| needs: conda-cpp-build | |
| secrets: inherit | |
| uses: rapidsai/shared-workflows/.github/workflows/[email protected] | |
| with: | |
| build_type: pull-request | |
| conda-python-tests: | |
| needs: [conda-python-build, changed-files] | |
| secrets: inherit | |
| uses: rapidsai/shared-workflows/.github/workflows/[email protected] | |
| if: fromJSON(needs.changed-files.outputs.changed_file_groups).test_python | |
| with: | |
| build_type: pull-request | |
| conda-notebook-tests: | |
| needs: [conda-python-build, changed-files] | |
| secrets: inherit | |
| uses: rapidsai/shared-workflows/.github/workflows/[email protected] | |
| if: fromJSON(needs.changed-files.outputs.changed_file_groups).test_notebooks | |
| with: | |
| build_type: pull-request | |
| node_type: "gpu-v100-latest-1" | |
| arch: "amd64" | |
| container_image: "rapidsai/ci-conda:cuda11.8.0-ubuntu22.04-py3.10" | |
| run_script: "ci/test_notebooks.sh" | |
| docs-build: | |
| needs: conda-python-build | |
| secrets: inherit | |
| uses: rapidsai/shared-workflows/.github/workflows/[email protected] | |
| with: | |
| build_type: pull-request | |
| node_type: "gpu-v100-latest-1" | |
| arch: "amd64" | |
| container_image: "rapidsai/ci-conda:cuda11.8.0-ubuntu22.04-py3.10" | |
| run_script: "ci/build_docs.sh" | |
| wheel-build-pylibcugraph: | |
| needs: checks | |
| secrets: inherit | |
| uses: rapidsai/shared-workflows/.github/workflows/[email protected] | |
| with: | |
| build_type: pull-request | |
| script: ci/build_wheel_pylibcugraph.sh | |
| extra-repo: rapidsai/cugraph-ops | |
| extra-repo-sha: branch-24.12 | |
| extra-repo-deploy-key: CUGRAPH_OPS_SSH_PRIVATE_DEPLOY_KEY | |
| node_type: cpu32 | |
| wheel-tests-pylibcugraph: | |
| needs: [wheel-build-pylibcugraph, changed-files] | |
| secrets: inherit | |
| uses: rapidsai/shared-workflows/.github/workflows/[email protected] | |
| if: fromJSON(needs.changed-files.outputs.changed_file_groups).test_python | |
| with: | |
| build_type: pull-request | |
| script: ci/test_wheel_pylibcugraph.sh | |
| wheel-build-cugraph: | |
| needs: wheel-tests-pylibcugraph | |
| secrets: inherit | |
| uses: rapidsai/shared-workflows/.github/workflows/[email protected] | |
| with: | |
| build_type: pull-request | |
| script: ci/build_wheel_cugraph.sh | |
| extra-repo: rapidsai/cugraph-ops | |
| extra-repo-sha: branch-24.12 | |
| extra-repo-deploy-key: CUGRAPH_OPS_SSH_PRIVATE_DEPLOY_KEY | |
| wheel-tests-cugraph: | |
| needs: [wheel-build-cugraph, changed-files] | |
| secrets: inherit | |
| uses: rapidsai/shared-workflows/.github/workflows/[email protected] | |
| if: fromJSON(needs.changed-files.outputs.changed_file_groups).test_python | |
| with: | |
| build_type: pull-request | |
| script: ci/test_wheel_cugraph.sh | |
| devcontainer: | |
| secrets: inherit | |
| needs: telemetry-setup | |
| uses: rapidsai/shared-workflows/.github/workflows/[email protected] | |
| with: | |
| arch: '["amd64"]' | |
| cuda: '["12.5"]' | |
| node_type: cpu32 | |
| extra-repo-deploy-key: CUGRAPH_OPS_SSH_PRIVATE_DEPLOY_KEY | |
| build_command: | | |
| sccache -z; | |
| build-all --verbose -j$(nproc --ignore=1) -DBUILD_CUGRAPH_MG_TESTS=ON; | |
| sccache -s; | |
| telemetry-summarize: | |
| runs-on: ubuntu-latest | |
| needs: pr-builder | |
| if: always() | |
| continue-on-error: true | |
| steps: | |
| - name: Load stashed telemetry env vars | |
| uses: rapidsai/shared-actions/telemetry-dispatch-load-base-env-vars@main | |
| with: | |
| load_service_name: true | |
| - name: Telemetry summarize | |
| uses: rapidsai/shared-actions/telemetry-dispatch-write-summary@main | |
| with: | |
| cert_concat: "${{ secrets.OTEL_EXPORTER_OTLP_CA_CERTIFICATE }};${{ secrets.OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE }};${{ secrets.OTEL_EXPORTER_OTLP_CLIENT_KEY }}" |