Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Repot all templates into a single directory #3460

Merged
merged 29 commits into from
Mar 5, 2024
Merged

Conversation

kianenigma
Copy link
Contributor

@kianenigma kianenigma commented Feb 23, 2024

The first step towards #3155

Brings all templates under the following structure

templates
|   parachain
|   |   polkadot-launch
|   |   runtime              --> parachain-template-runtime
|   |   pallets              --> pallet-parachain-template
|   |   node                 --> parachain-template-node
|   minimal
|   |   runtime              --> minimal-template-runtime
|   |   pallets              --> pallet-minimal-template
|   |   node                 --> minimal-template-node
|   solochain
|   |   runtime              --> solochain-template-runtime
|   |   pallets              --> pallet-template (the naming is not consistent here)
|   |   node                 --> solochain-template-node

The only note-worthy changes in this PR are:

  • More Cargo.toml fields are forwarded to use the one from the workspace.
  • parachain template now has weights and benchmarks
  • adds a shell pallet to the minimal template
  • remove a few unused deps

A list of possible follow-ups:

@kianenigma kianenigma added T1-FRAME This PR/Issue is related to core FRAME, the framework. T11-documentation This PR/Issue is related to documentation. labels Feb 23, 2024
@kianenigma kianenigma requested a review from a team as a code owner February 23, 2024 13:14
@kianenigma kianenigma requested review from a team as code owners February 23, 2024 13:19
templates/solochain/runtime/src/lib.rs Outdated Show resolved Hide resolved
@@ -0,0 +1,35 @@
//! Benchmarking setup for pallet-template
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Header missing?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These files didn't have a license header beforehand, not adding them here to minimize diff, but it is a follow-up.

Copy link
Member

@ggwpez ggwpez Feb 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe worth adding something here for the templates:

- name: Check the licenses in Substrate

templates/minimal/pallets/template/src/lib.rs Show resolved Hide resolved
@kianenigma
Copy link
Contributor Author

merge issues are due to #3002

@liamaharon liamaharon self-requested a review February 24, 2024 08:18
@skunert skunert self-requested a review February 29, 2024 12:39
@kianenigma kianenigma added the R0-silent Changes should not be mentioned in any release notes label Feb 29, 2024
@skunert
Copy link
Contributor

skunert commented Feb 29, 2024

CI Leftover that needs adjusting:

- time cargo check --locked -p parachain-template-node --features try-runtime

Copy link
Contributor

@skunert skunert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This structure makes a lot of sense, nice!

templates/parachain/polkadot-launch/config.json Outdated Show resolved Hide resolved
templates/parachain/node/src/cli.rs Outdated Show resolved Hide resolved
@kianenigma kianenigma removed the R0-silent Changes should not be mentioned in any release notes label Feb 29, 2024
@paritytech-cicd-pr
Copy link

The CI pipeline was cancelled due to failure one of the required jobs.
Job name: cargo-clippy
Logs: https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/5437671

@kianenigma kianenigma added this pull request to the merge queue Mar 5, 2024
Merged via the queue into master with commit 4c81060 Mar 5, 2024
128 of 130 checks passed
@kianenigma kianenigma deleted the kiz-repot-templates branch March 5, 2024 13:47
bgallois pushed a commit to duniter/duniter-polkadot-sdk that referenced this pull request Mar 25, 2024
The first step towards
paritytech#3155

Brings all templates under the following structure

```
templates
|   parachain
|   |   polkadot-launch
|   |   runtime              --> parachain-template-runtime
|   |   pallets              --> pallet-parachain-template
|   |   node                 --> parachain-template-node
|   minimal
|   |   runtime              --> minimal-template-runtime
|   |   pallets              --> pallet-minimal-template
|   |   node                 --> minimal-template-node
|   solochain
|   |   runtime              --> solochain-template-runtime
|   |   pallets              --> pallet-template (the naming is not consistent here)
|   |   node                 --> solochain-template-node
```

The only note-worthy changes in this PR are: 

- More `Cargo.toml` fields are forwarded to use the one from the
workspace.
- parachain template now has weights and benchmarks
- adds a shell pallet to the minimal template
- remove a few unused deps 


A list of possible follow-ups: 

- [ ] Unify READMEs, create a parent README for all
- [ ] remove references to `docs.substrate.io` in templates
- [ ] make all templates use `#[derive_impl]`
- [ ] update and unify all licenses
- [ ] Remove polkadot launch, use
https://github.com/paritytech/polkadot-sdk/blob/35349df993ea2e7c4769914ef5d199e787b23d4c/cumulus/zombienet/examples/small_network.toml
instead.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T1-FRAME This PR/Issue is related to core FRAME, the framework. T11-documentation This PR/Issue is related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants