- Notifications
You must be signed in to change notification settings - Fork23
Update Parity Docs#60
This file contains hidden or 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:Update Parity Docs | |
| on: | |
| schedule: | |
| -cron:0 5 * * MON | |
| workflow_dispatch: | |
| inputs: | |
| targetBranch: | |
| required:false | |
| type:string | |
| default:'main' | |
| jobs: | |
| update-parity-coverage-docs: | |
| name:Update Parity Docs | |
| runs-on:ubuntu-latest | |
| steps: | |
| -name:Checkout docs | |
| uses:actions/checkout@v4 | |
| with: | |
| fetch-depth:0 | |
| path:docs | |
| ref:${{ github.event.inputs.targetBranch || 'main' }} | |
| -name:Set up system wide dependencies | |
| run:| | |
| sudo apt-get install jq wget | |
| -name:Set up Python 3.11 | |
| id:setup-python | |
| uses:actions/setup-python@v5 | |
| with: | |
| python-version:"3.11" | |
| -name:Setup Node | |
| uses:actions/setup-node@v4 | |
| with: | |
| node-version:'20' | |
| -name:Download scripts from meta repository | |
| run:| | |
| curl -o /tmp/get_latest_github_metrics.sh -L https://raw.githubusercontent.com/localstack/meta/main/scripts/get_latest_github_metrics.sh -H 'Accept: application/vnd.github.v3.raw' | |
| chmod +x /tmp/get_latest_github_metrics.sh | |
| -name:Download metrics data from Terraform Integration test pipeline (GitHub) | |
| working-directory:docs | |
| run:/tmp/get_latest_github_metrics.sh ./target main | |
| env: | |
| GITHUB_TOKEN:${{ secrets.PRO_ACCESS_TOKEN }} | |
| REPOSITORY_NAME:localstack-terraform-test | |
| ARTIFACT_ID:test-metrics | |
| WORKFLOW:"Terraform Tests" | |
| FILTER_SUCCESS:0 | |
| -name:Download metrics data from Pro pipeline (GitHub) | |
| working-directory:docs | |
| run:/tmp/get_latest_github_metrics.sh ./target main | |
| env: | |
| GITHUB_TOKEN:${{ secrets.PRO_ACCESS_TOKEN }} | |
| REPOSITORY_NAME:localstack-pro | |
| ARTIFACT_ID:parity-metric-pro-raw-amd* | |
| WORKFLOW:"AWS / Build, Test, Push" | |
| PREFIX_ARTIFACT:pro-integration-test | |
| -name:Download coverage (capture-notimplemented) data from Pro pipeline (GitHub) | |
| working-directory:docs | |
| run:/tmp/get_latest_github_metrics.sh ./target main | |
| env: | |
| GITHUB_TOKEN:${{ secrets.PRO_ACCESS_TOKEN }} | |
| REPOSITORY_NAME:localstack-pro | |
| ARTIFACT_ID:capture-notimplemented-pro | |
| WORKFLOW:"AWS / Build, Test, Push" | |
| RESOURCE_FOLDER:"metrics-implementation-details" | |
| -name:Download metrics data from Community pipeline (GitHub) | |
| working-directory:docs | |
| run:/tmp/get_latest_github_metrics.sh ./target main | |
| env: | |
| GITHUB_TOKEN:${{ secrets.PRO_ACCESS_TOKEN }} | |
| REPOSITORY_NAME:localstack | |
| ARTIFACT_ID:parity-metric-raw-amd* | |
| WORKFLOW:"AWS / Build, Test, Push" | |
| PREFIX_ARTIFACT:community-integration-test | |
| -name:Download coverage (capture-notimplemented) data from Community pipeline (GitHub) | |
| working-directory:docs | |
| run:/tmp/get_latest_github_metrics.sh ./target main | |
| env: | |
| GITHUB_TOKEN:${{ secrets.PRO_ACCESS_TOKEN }} | |
| REPOSITORY_NAME:localstack | |
| ARTIFACT_ID:capture-notimplemented | |
| WORKFLOW:"AWS / Build, Test, Push" | |
| RESOURCE_FOLDER:"metrics-implementation-details/community" | |
| -name:Download CloudFormation catalog from Pro pipeline (GitHub) | |
| working-directory:docs | |
| continue-on-error:true | |
| run:/tmp/get_latest_github_metrics.sh ./target main | |
| env: | |
| GITHUB_TOKEN:${{ secrets.PRO_ACCESS_TOKEN }} | |
| REPOSITORY_NAME:localstack-pro | |
| ARTIFACT_ID:iac-catalog-assets | |
| WORKFLOW:"IaC – Generate Catalog Assets" | |
| RESOURCE_FOLDER:"iac-catalog-assets" | |
| -name:Download coverage data for K8s pipeline (acceptance tests) (GitHub) | |
| working-directory:docs | |
| run:/tmp/get_latest_github_metrics.sh ./target main | |
| env: | |
| GITHUB_TOKEN:${{ secrets.PRO_ACCESS_TOKEN }} | |
| REPOSITORY_NAME:localstack-pro | |
| ARTIFACT_ID:parity-metric-pro-k8s-acceptance-raw-amd64-* | |
| WORKFLOW:"AWS / Pro K8s tests" | |
| PREFIX_ARTIFACT:k8s-acceptance-test | |
| -name:Download coverage data for K8s pipeline (integration tests) (GitHub) | |
| working-directory:docs | |
| run:/tmp/get_latest_github_metrics.sh ./target main | |
| env: | |
| GITHUB_TOKEN:${{ secrets.PRO_ACCESS_TOKEN }} | |
| REPOSITORY_NAME:localstack-pro | |
| ARTIFACT_ID:parity-metric-pro-k8s-integration-raw-amd64-* | |
| WORKFLOW:"AWS / Pro K8s tests" | |
| PREFIX_ARTIFACT:k8s-integration-test | |
| -name:Download coverage data for community K8s pipeline (integration tests) (GitHub) | |
| working-directory:docs | |
| run:/tmp/get_latest_github_metrics.sh ./target main | |
| env: | |
| GITHUB_TOKEN:${{ secrets.PRO_ACCESS_TOKEN }} | |
| REPOSITORY_NAME:localstack-pro | |
| ARTIFACT_ID:parity-metric-community-k8s-integration-raw-* | |
| WORKFLOW:"AWS / Community K8S tests" | |
| PREFIX_ARTIFACT:k8s-community-integration-test | |
| -name:Create Parity Coverage Docs | |
| working-directory:docs | |
| run:| | |
| python3 -m scripts.create_data_coverage -i target/metrics-implementation-details -r target/metrics-raw -o target/updated_coverage -s src/data/coverage/service_display_name.json | |
| mv -f target/updated_coverage/data/*.json src/data/coverage | |
| -name:Generate CloudFormation Coverage Tables | |
| working-directory:docs | |
| continue-on-error:true | |
| run:| | |
| python3 scripts/create_cfn_coverage_table.py --cfn-json target/iac-catalog-assets/cfn_resources.json | |
| -name:Check for changes | |
| id:check-for-changes | |
| working-directory:docs | |
| run:| | |
| # Check if there are changed files and store the result in resources/diff-check.log | |
| # Check against the PR branch if it exists, otherwise against the main | |
| # Store the result in resources/diff-check.log and store the diff count in the GitHub Action output "diff-count" | |
| mkdir -p resources | |
| FILES_TO_CHECK="src/data/coverage/ src/content/docs/aws/services/cloudformation.mdx" | |
| (git diff --name-only origin/parity-coverage-auto-updates $FILES_TO_CHECK 2>/dev/null || git diff --name-only origin/${{ github.event.inputs.targetBranch || 'main' }} $FILES_TO_CHECK 2>/dev/null) | tee -a resources/diff-check.log | |
| echo "diff-count=$(cat resources/diff-check.log | wc -l)" >> $GITHUB_OUTPUT | |
| -name:Read PR markdown template | |
| if:${{ success() && steps.check-for-changes.outputs.diff-count != '0' && steps.check-for-changes.outputs.diff-count != '' }} | |
| id:template | |
| uses:juliangruber/read-file-action@v1 | |
| with: | |
| path:docs/.github/bot_templates/PARITY_COVERAGE_DOCS_PR.md | |
| -name:Create PR | |
| uses:peter-evans/create-pull-request@v7 | |
| if:${{ success() && steps.check-for-changes.outputs.diff-count != '0' && steps.check-for-changes.outputs.diff-count != '' }} | |
| with: | |
| path:docs | |
| title:"Update Parity Coverage Docs" | |
| body:"${{ steps.template.outputs.content }}" | |
| branch:"parity-coverage-auto-updates" | |
| author:"LocalStack Bot <localstack-bot@users.noreply.github.com>" | |
| committer:"LocalStack Bot <localstack-bot@users.noreply.github.com>" | |
| commit-message:"update generated parity coverage docs" | |
| token:${{ secrets.PRO_ACCESS_TOKEN }} |