Skip to content
Snippets Groups Projects
user avatar
Iulian Barbu authored
# Description

We're unable to sync templates repos with what's in
polkadot-sdk/templates for stable2412 because the tag which references
the release (`polkadot-stable2412`) is missing the Plan.toml file, which
is needed by PSVM, ran when syncing, to update the templates
dependencies versions in Cargo.tomls. This PR adds a workflow `patch`
input, to enable the workflow to use PSVM with a tag corresponding to a
patch stable release (e.g. `polkadot-stable2412-1`), which will contain
the `Plan.toml` file.

## Integration

This enables the templates repos update with the contents of latest
stable2412 release, in terms of polkadot-sdk/templates, which is
relevant for getting-started docs.

## Review Notes

This PR adds a `patch` input for the `misc-sync-templates.yml` workflow,
which if set will be used with `psvm` accordingly to update templates
repos' dependencies versions based on upcomming patch stable2412-1,
which contains the `Plan.toml`. The workflow will be ran manually after
stable2412-1 is out and this work is tracked under #6329 .

Signed-off-by: default avatarIulian Barbu <iulian.barbu@parity.io>
ccd6337f

SDK Logo SDK Logo

Polkadot SDK

GitHub stars  GitHub forks

StackExchange  GitHub contributors  GitHub commit activity  GitHub last commit

The Polkadot SDK repository provides all the components needed to start building on the Polkadot network, a multi-chain blockchain platform that enables different blockchains to interoperate and share information in a secure and scalable way.

⚡ Quickstart

If you want to get an example node running quickly you can execute the following getting started script:

curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/paritytech/polkadot-sdk/master/scripts/getting-started.sh | bash

📚 Documentation

🚀 Releases

Current Stable Release  Next Stable Release

The Polkadot SDK is released every three months as a stableYYMM release. They are supported for one year with patches. See the next upcoming versions in the Release Registry and more docs in RELEASE.md.

You can use psvm to update all dependencies to a specific version without needing to manually select the correct version for each crate.

🛠️ Tooling

Polkadot SDK Version Manager: A simple tool to manage and update the Polkadot SDK dependencies in any Cargo.toml file. It will automatically update the Polkadot SDK dependencies to their correct crates.io version.

🔐 Security

The security policy and procedures can be found in docs/contributor/SECURITY.md.

🤍 Contributing & Code of Conduct

Ensure you follow our contribution guidelines. In every interaction and contribution, this project adheres to the Contributor Covenant Code of Conduct.

👾 Ready to Contribute?

Take a look at the issues labeled with mentor (or alternatively this page, created by one of the maintainers) label to get started! We always recognize valuable contributions by proposing an on-chain tip to the Polkadot network as a token of our appreciation.

Polkadot Fellowship

Development in this repo usually goes hand in hand with the fellowship organization. In short, this repository provides all the SDK pieces needed to build both Polkadot and its parachains. But, the actual Polkadot runtime lives in the fellowship/runtimes repository. Read more about the fellowship, this separation, the RFC process here.

History

This repository is the amalgamation of 3 separate repositories that used to make up Polkadot SDK, namely Substrate, Polkadot and Cumulus. Read more about the merge and its history here.