Merge branch 'master' into as-test-mac

.config/zepter.yaml

@@ -27,7 +27,7 @@ workflows:
       ]
   # The umbrella crate uses more features, so we to check those too:
   check_umbrella:
-    - [ $check.0, '--features=serde,experimental,runtime,with-tracing,tuples-96,with-tracing', '-p=polkadot-sdk' ]
+    - [ $check.0, '--features=serde,experimental,riscv,runtime,with-tracing,tuples-96,with-tracing', '-p=polkadot-sdk' ]
   # Same as `check_*`, but with the `--fix` flag.
   default:
     - [ $check.0, '--fix' ]

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1 @@
+../../docs/contributor/PULL_REQUEST_TEMPLATE.md

.github/scripts/generate-readmes.py

@@ -0,0 +1,136 @@
+#!/usr/bin/env python3
+
+"""
+A script to generate READMEs for all public crates,
+if they do not already have one.
+
+It relies on functions from the `check-workspace.py` script.
+
+The resulting README is based on a template defined below,
+and includes the crate name, description, license,
+and optionally - the SDK release version.
+
+# Example
+
+```sh
+python3 -m pip install toml
+.github/scripts/generate-readmes.py . --sdk-version 1.15.0
+```
+"""
+
+import os
+import toml
+import importlib
+import argparse
+
+check_workspace = importlib.import_module("check-workspace")
+
+README_TEMPLATE = """<div align="center">
+
+<img src="https://raw.githubusercontent.com/paritytech/polkadot-sdk/master/docs/images/Polkadot_Logo_Horizontal_Pink_BlackOnWhite.png" alt="Polkadot logo" width="200">
+
+# {name}
+
+This crate is part of the [Polkadot SDK](https://github.com/paritytech/polkadot-sdk/).
+
+</div>
+
+## Description
+
+{description}
+
+## Additional Resources
+
+In order to learn about Polkadot SDK, head over to the [Polkadot SDK Developer Documentation](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/index.html).
+
+To learn about Polkadot, visit [polkadot.com](https://polkadot.com/).
+
+## License
+
+This crate is licensed with {license}.
+"""
+
+VERSION_TEMPLATE = """
+## Version
+
+This version of `{name}` is associated with Polkadot {sdk_version} release.
+"""
+
+
+def generate_readme(member, *, workspace_dir, workspace_license, sdk_version):
+    print(f"Loading manifest for: {member}")
+    manifest = toml.load(os.path.join(workspace_dir, member, "Cargo.toml"))
+    if manifest["package"].get("publish", True) == False:
+        print(f"⏩ Skipping un-published crate: {member}")
+        return
+    if os.path.exists(os.path.join(workspace_dir, member, "README.md")):
+        print(f"⏩ Skipping crate with an existing readme: {member}")
+        return
+    print(f"📝 Generating README for: {member}")
+
+    license = manifest["package"]["license"]
+    if isinstance(license, dict):
+        if not license.get("workspace", False):
+            print(
+                f"❌ License for {member} is unexpectedly declared as workspace=false."
+            )
+            # Skipping this crate as it is not clear what license it should use.
+            return
+        license = workspace_license
+
+    name = manifest["package"]["name"]
+    description = manifest["package"]["description"]
+    description = description + "." if not description.endswith(".") else description
+
+    filled_readme = README_TEMPLATE.format(
+        name=name, description=description, license=license
+    )
+
+    if sdk_version:
+        filled_readme += VERSION_TEMPLATE.format(name=name, sdk_version=sdk_version)
+
+    with open(os.path.join(workspace_dir, member, "README.md"), "w") as new_readme:
+        new_readme.write(filled_readme)
+
+
+def parse_args():
+    parser = argparse.ArgumentParser(
+        description="Generate readmes for published crates."
+    )
+
+    parser.add_argument(
+        "workspace_dir",
+        help="The directory to check",
+        metavar="workspace_dir",
+        type=str,
+        nargs=1,
+    )
+    parser.add_argument(
+        "--sdk-version",
+        help="Optional SDK release version",
+        metavar="sdk_version",
+        type=str,
+        nargs=1,
+        required=False,
+    )
+
+    args = parser.parse_args()
+    return (args.workspace_dir[0], args.sdk_version[0] if args.sdk_version else None)
+
+
+def main():
+    (workspace_dir, sdk_version) = parse_args()
+    root_manifest = toml.load(os.path.join(workspace_dir, "Cargo.toml"))
+    workspace_license = root_manifest["workspace"]["package"]["license"]
+    members = check_workspace.get_members(workspace_dir, [])
+    for member in members:
+        generate_readme(
+            member,
+            workspace_dir=workspace_dir,
+            workspace_license=workspace_license,
+            sdk_version=sdk_version,
+        )
+
+
+if __name__ == "__main__":
+    main()

.github/workflows/checks-quick.yml

@@ -100,6 +100,8 @@ jobs:
           --exclude
           "substrate/frame/contracts/fixtures/build"
           "substrate/frame/contracts/fixtures/contracts/common"
+          "substrate/frame/revive/fixtures/build"
+          "substrate/frame/revive/fixtures/contracts/common"
       - name: deny git deps
         run: python3 .github/scripts/deny-git-deps.py .
   check-markdown:
@@ -154,3 +156,28 @@ jobs:
             git diff
             exit 1
           fi
+  check-fail-ci:
+    runs-on: ubuntu-latest
+    container:
+      # there's no "rg" in ci-unified, and tools is a smaller image anyway
+      image: "paritytech/tools:latest"
+      # paritytech/tools uses "nonroot" user by default, which doesn't have enough
+      # permissions to create GHA context
+      options: --user root
+    steps:
+      - name: Fetch latest code
+        uses: actions/checkout@v4
+      - name: Check
+        run: |
+          set +e
+          rg --line-number --hidden --type rust --glob '!{.git,target}' "$ASSERT_REGEX" .; exit_status=$?
+          if [ $exit_status -eq 0 ]; then
+            echo "$ASSERT_REGEX was found, exiting with 1";
+            exit 1;
+            else
+            echo "No $ASSERT_REGEX was found, exiting with 0";
+            exit 0;
+          fi
+        env:
+          ASSERT_REGEX: "FAIL-CI"
+          GIT_DEPTH: 1

.github/workflows/docs.yml

@@ -0,0 +1,141 @@
+name: Docs
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review, labeled]
+  merge_group:
+
+concurrency:
+  group: ${{ github.ref }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/master' }}
+
+jobs:
+  set-image:
+    # GitHub Actions allows using 'env' in a container context.
+    # However, env variables don't work for forks: https://github.com/orgs/community/discussions/44322
+    # This workaround sets the container image for each job using 'set-image' job output.
+    # TODO: remove once migration is complete or this workflow is fully stable
+    if: contains(github.event.label.name, 'GHA-migration') || contains(github.event.pull_request.labels.*.name, 'GHA-migration')
+    runs-on: ubuntu-latest
+    outputs:
+      IMAGE: ${{ steps.set_image.outputs.IMAGE }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - id: set_image
+        run: cat .github/env >> $GITHUB_OUTPUT
+  test-rustdoc:
+    runs-on: arc-runners-polkadot-sdk-beefy
+    needs: [set-image]
+    container:
+      image: ${{ needs.set-image.outputs.IMAGE }}
+    steps:
+      - uses: actions/checkout@v4
+      - run: forklift cargo doc --workspace --all-features --no-deps
+        env:
+          SKIP_WASM_BUILD: 1
+  test-doc:
+    runs-on: arc-runners-polkadot-sdk-beefy
+    needs: [set-image]
+    container:
+      image: ${{ needs.set-image.outputs.IMAGE }}
+    steps:
+      - uses: actions/checkout@v4
+      - run: forklift cargo test --doc --workspace
+        env:
+          RUSTFLAGS: "-Cdebug-assertions=y -Dwarnings"
+
+  build-rustdoc:
+    runs-on: arc-runners-polkadot-sdk-beefy
+    needs: [set-image, test-rustdoc]
+    container:
+      image: ${{ needs.set-image.outputs.IMAGE }}
+    steps:
+      - uses: actions/checkout@v4
+      - run: forklift cargo doc --all-features --workspace --no-deps
+        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
+
+  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
+
+  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 to GH-Pages branch
+        uses: github-actions-x/commit@v2.9
+        with:
+          github-token: ${{ steps.app-token.outputs.token }}
+          push-branch: "gh-pages"
+          commit-message: "___Updated docs for ${{ github.head_ref || github.ref_name }}___"
+          force-add: "true"
+          files: ${{ github.head_ref || github.ref_name }}/ book/
+          name: devops-parity
+          email: devops-team@parity.io

.gitlab/pipeline/check.yml

@@ -122,26 +122,6 @@ check-runtime-migration-rococo:
     URI: "wss://rococo-try-runtime-node.parity-chains.parity.io:443"
     SUBCOMMAND_EXTRA_ARGS: "--no-weight-warnings"
 
-find-fail-ci-phrase:
-  stage: check
-  variables:
-    CI_IMAGE: "paritytech/tools:latest"
-    ASSERT_REGEX: "FAIL-CI"
-    GIT_DEPTH: 1
-  extends:
-    - .kubernetes-env
-    - .test-pr-refs
-  script:
-    - set +e
-    - rg --line-number --hidden --type rust --glob '!{.git,target}' "$ASSERT_REGEX" .; exit_status=$?
-    - if [ $exit_status -eq 0 ]; then
-      echo "$ASSERT_REGEX was found, exiting with 1";
-      exit 1;
-      else
-      echo "No $ASSERT_REGEX was found, exiting with 0";
-      exit 0;
-      fi
-
 check-core-crypto-features:
   stage: check
   extends:

CODE_OF_CONDUCT.md

@@ -0,0 +1 @@
+docs/contributor/CODE_OF_CONDUCT.md

CONTRIBUTING.md

@@ -0,0 +1 @@
+docs/contributor/CONTRIBUTING.md