Bridges - Add improved congestion control mechanism #11603
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: Docs | |
| on: | |
| push: | |
| branches: | |
| - master | |
| pull_request: | |
| types: [opened, synchronize, reopened, ready_for_review, labeled] | |
| merge_group: | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| preflight: | |
| uses: ./.github/workflows/reusable-preflight.yml | |
| test-doc: | |
| runs-on: ${{ needs.preflight.outputs.RUNNER }} | |
| timeout-minutes: 60 | |
| needs: [preflight] | |
| container: | |
| image: ${{ needs.preflight.outputs.IMAGE }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - run: forklift cargo test --doc --workspace | |
| id: required | |
| env: | |
| RUSTFLAGS: "-Cdebug-assertions=y -Dwarnings" | |
| - name: Stop all workflows if failed | |
| if: ${{ failure() && steps.required.conclusion == 'failure' && !github.event.pull_request.head.repo.fork }} | |
| uses: ./.github/actions/workflow-stopper | |
| with: | |
| app-id: ${{ secrets.WORKFLOW_STOPPER_RUNNER_APP_ID }} | |
| app-key: ${{ secrets.WORKFLOW_STOPPER_RUNNER_APP_KEY }} | |
| build-rustdoc: | |
| runs-on: ${{ needs.preflight.outputs.RUNNER }} | |
| timeout-minutes: 40 | |
| if: ${{ needs.preflight.outputs.changes_rust }} | |
| needs: [preflight] | |
| container: | |
| image: ${{ needs.preflight.outputs.IMAGE }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - run: forklift cargo doc --all-features --workspace --no-deps | |
| id: required | |
| env: | |
| SKIP_WASM_BUILD: 1 | |
| RUSTDOCFLAGS: "-Dwarnings --default-theme=ayu --html-in-header ./docs/sdk/assets/header.html --extend-css ./docs/sdk/assets/theme.css --html-after-content ./docs/sdk/assets/after-content.html" | |
| - run: rm -f ./target/doc/.lock | |
| - run: mv ./target/doc ./crate-docs | |
| - name: Inject Simple Analytics script | |
| run: | | |
| script_content="<script async defer src=\"https://apisa.parity.io/latest.js\"></script><noscript><img src=\"https://apisa.parity.io/latest.js\" alt=\"\" referrerpolicy=\"no-referrer-when-downgrade\" /></noscript>" | |
| docs_dir="./crate-docs" | |
| inject_simple_analytics() { | |
| find "$1" -name '*.html' | xargs -I {} -P "$(nproc)" bash -c 'file="{}"; echo "Adding Simple Analytics script to $file"; sed -i "s|</head>|'"$2"'</head>|" "$file";' | |
| } | |
| inject_simple_analytics "$docs_dir" "$script_content" | |
| - run: echo "<meta http-equiv=refresh content=0;url=polkadot_sdk_docs/index.html>" > ./crate-docs/index.html | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: ${{ github.sha }}-doc | |
| path: ./crate-docs/ | |
| retention-days: 1 | |
| if-no-files-found: error | |
| - name: Stop all workflows if failed | |
| if: ${{ failure() && steps.required.conclusion == 'failure' && !github.event.pull_request.head.repo.fork }} | |
| uses: ./.github/actions/workflow-stopper | |
| with: | |
| app-id: ${{ secrets.WORKFLOW_STOPPER_RUNNER_APP_ID }} | |
| app-key: ${{ secrets.WORKFLOW_STOPPER_RUNNER_APP_KEY }} | |
| build-implementers-guide: | |
| runs-on: ubuntu-latest | |
| container: | |
| image: paritytech/mdbook-utils:e14aae4a-20221123 | |
| options: --user root | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - run: mdbook build ./polkadot/roadmap/implementers-guide | |
| - run: mkdir -p artifacts | |
| - run: mv polkadot/roadmap/implementers-guide/book artifacts/ | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: ${{ github.sha }}-guide | |
| path: ./artifacts/ | |
| retention-days: 1 | |
| if-no-files-found: error | |
| confirm-required-jobs-passed: | |
| runs-on: ubuntu-latest | |
| name: All docs jobs passed | |
| # If any new job gets added, be sure to add it to this array | |
| needs: [test-doc, build-rustdoc, build-implementers-guide] | |
| if: always() && !cancelled() | |
| steps: | |
| - run: | | |
| tee resultfile <<< '${{ toJSON(needs) }}' | |
| FAILURES=$(cat resultfile | grep '"result": "failure"' | wc -l) | |
| if [ $FAILURES -gt 0 ]; then | |
| echo "### At least one required job failed ❌" >> $GITHUB_STEP_SUMMARY | |
| exit 1 | |
| else | |
| echo '### Good job! All the required jobs passed 🚀' >> $GITHUB_STEP_SUMMARY | |
| fi | |
| publish-rustdoc: | |
| if: github.ref == 'refs/heads/master' | |
| runs-on: ubuntu-latest | |
| environment: subsystem-benchmarks | |
| needs: [build-rustdoc, build-implementers-guide] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| ref: gh-pages | |
| - uses: actions/create-github-app-token@v1 | |
| id: app-token | |
| with: | |
| app-id: ${{ secrets.POLKADOTSDK_GHPAGES_APP_ID }} | |
| private-key: ${{ secrets.POLKADOTSDK_GHPAGES_APP_KEY }} | |
| - name: Ensure destination dir does not exist | |
| run: | | |
| rm -rf book/ | |
| rm -rf ${REF_NAME} | |
| env: | |
| REF_NAME: ${{ github.head_ref || github.ref_name }} | |
| - name: Download rustdocs | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: ${{ github.sha }}-doc | |
| path: ${{ github.head_ref || github.ref_name }} | |
| - name: Download guide | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: ${{ github.sha }}-guide | |
| path: /tmp | |
| - run: mkdir -p book | |
| - name: Move book files | |
| run: mv /tmp/book/html/* book/ | |
| - name: Push changes to gh-pages | |
| env: | |
| TOKEN: ${{ steps.app-token.outputs.token }} | |
| APP_NAME: "paritytech-upd-ghpages-polkadotsdk" | |
| REF_NAME: ${{ github.head_ref || github.ref_name }} | |
| Green: "\e[32m" | |
| NC: "\e[0m" | |
| run: | | |
| echo "${Green}Git add${NC}" | |
| git add book/ | |
| git add ${REF_NAME}/ | |
| echo "${Green}git status | wc -l${NC}" | |
| git status | wc -l | |
| echo "${Green}Add new remote with gh app token${NC}" | |
| git remote set-url origin $(git config remote.origin.url | sed "s/github.com/${APP_NAME}:${TOKEN}@github.com/g") | |
| echo "${Green}Remove http section that causes issues with gh app auth token${NC}" | |
| sed -i.bak '/\[http/d' ./.git/config | |
| sed -i.bak '/extraheader/d' ./.git/config | |
| echo "${Green}Git push${NC}" | |
| git config user.email "[email protected]" | |
| git config user.name "${APP_NAME}" | |
| git commit --amend -m "___Updated docs" || echo "___Nothing to commit___" | |
| git push origin gh-pages --force |