-
Notifications
You must be signed in to change notification settings - Fork 696
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into ao-fix-backing-filtering-on-disputes
* master: (36 commits) Bump the ci_dependencies group across 1 directory with 2 updates (#5401) Remove deprecated calls in cumulus-parachain-system (#5439) Make the PR template a default for new PRs (#5462) Only log the propagating transactions when they are not empty (#5424) [CI] Fix SemVer check base commit (#5361) Sync status refactoring (#5450) Add build options to the srtool build step (#4956) `MaybeConsideration` extension trait for `Consideration` (#5384) Skip slot before creating inherent data providers during major sync (#5344) Add symlinks for code of conduct and contribution guidelines (#5447) pallet-collator-selection: correctly register weight in `new_session` (#5430) Derive `Clone` on `EncodableOpaqueLeaf` (#5442) Moving `Find FAIL-CI` check to GHA (#5377) Remove panic, as proof is invalid. (#5427) Reactive syncing metrics (#5410) [bridges] Prune messages from confirmation tx body, not from the on_idle (#5006) Change the chain to Rococo in the parachain template Zombienet config (#5279) Improve the appearance of crates on `crates.io` (#5243) Add initial version of `pallet_revive` (#5293) Update OpenZeppelin template documentation (#5398) ...
- Loading branch information
Showing
304 changed files
with
31,088 additions
and
2,573 deletions.
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
../docs/contributor/PULL_REQUEST_TEMPLATE.md |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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() |
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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/[email protected] | ||
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: [email protected] |
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
Oops, something went wrong.