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

Update make helpers #11

Merged
merged 6 commits into from
Oct 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
# precedence.

# Default owners for everything:
* @NukeManDan
* @Asamartino

# See https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
33 changes: 26 additions & 7 deletions Makefile.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,6 @@
# See all insluded task with:
# makers --list-all-steps

[tasks.default]
alias = "serve"
dependencies = ["check-install"]

[config]
# Catch errors and report to try and help user
on_error_task = "catch-error"
Expand All @@ -20,6 +16,10 @@ skip_rust_env_info = true
# Skips loading the current crate related environment variables
skip_crate_env_info = true

[tasks.default]
alias = "serve"
dependencies = ["check-install"]

# -----------------------------------------------------------------------------
# Installation

Expand All @@ -33,6 +33,11 @@ alias = "install-dev"

[tasks.ia]
category = "Install"
alias = "install-all"

[tasks.install-all]
description = "Install all dependencies for slides and book tooling, and dev tools."
category = "Install"
dependencies = ["install", "install-dev"]

[tasks.install]
Expand All @@ -53,7 +58,7 @@ if ! $(echo "type bun" | sh > /dev/null ); then
echo "🥟 Installing https://bun.sh ..."
curl -fsSL https://bun.sh/install | bash
fi
echo "💽 Bun installed."
echo "💽 Bun installed. NOTE: you may need to update your shell to include this, see above output."

echo "🥟 Install slides tooling with Bun..."
bun install
Expand All @@ -67,6 +72,7 @@ script = 'rm -rf node_modules/ html-slides/ html-book/ && makers ia'

[tasks.install-dev]
description = "Install dev tools."
category = "Install"
dependencies = ["install-linkcheck", "install-formatter"]

[tasks.install-linkcheck]
Expand All @@ -84,6 +90,15 @@ script = "cargo install --locked dprint"

[tasks.s]
alias = "serve"
category = "Serve"

[tasks.sb]
alias = "serve-book"
category = "Serve"

[tasks.ss]
alias = "serve-slides"
category = "Serve"

[tasks.serve]
# FIXME - want some way to have a watching server for slides AND the book. Likely some hooks in mdBook and/or reveal-md could be used.
Expand Down Expand Up @@ -170,9 +185,13 @@ script = "./tools/scripts/orphan-image-scan.sh content/"

[tasks.l]
category = "Checks"
alias = "all-links"
alias = "links"

[tasks.lf]
category = "Checks"
alias = "links-for"

[tasks.all-links]
[tasks.links]
category = "Checks"
description = "Check included links for all markup (.md|.html) files."
# FIXME .mlc.toml config not working... https://github.com/becheran/mlc/issues/78
Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Security Policy

See: <https://github.com/paritytech-stg/polkadot-sdk/blob/master/substrate/docs/SECURITY.md>
See: <https://github.com/paritytech/polkadot-sdk/blob/master/substrate/docs/SECURITY.md>
Original file line number Diff line number Diff line change
Expand Up @@ -365,4 +365,4 @@ pub trait Hooks<BlockNumber> {
}
```

Source: [`/frame/support/src/traits/hooks.rs`](https://github.com/paritytech-stg/polkadot-sdk/blob/a13382f/substrate/frame/support/src/traits/hooks.rs)
Source: [`/frame/support/src/traits/hooks.rs`](https://github.com/paritytech/polkadot-sdk/blob/a13382f/substrate/frame/support/src/traits/hooks.rs)
2 changes: 1 addition & 1 deletion content/contribute/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,7 @@ They typically are identical to:
- Always use proper MarkDown links!
`<https://parity.io>` is required, raw links _will not be rendered_ in mdBook!
- Never use links that are likely ephemeral and will break.
This example is in main, not some PR branch: <https://github.com/paritytech-stg/polkadot-sdk/blob/5174b9d/polkadot/roadmap/implementers-guide/src/node/backing/prospective-parachains.md>
This example is in main, not some PR branch: <https://github.com/paritytech/polkadot-sdk/blob/5174b9d/polkadot/roadmap/implementers-guide/src/node/backing/prospective-parachains.md>
You _must_ be permalinks to a commit hash when using a github link, not `main` or other branch.
- Reuse images and have no duplication of any images, with close _enough_ ones considered to replace where possible.
**_Relative_** paths are supported: `../../<other lesson>/img/<existing img>`
Expand Down
2 changes: 1 addition & 1 deletion content/cryptography/_materials/subkey-demo.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Subkey Signature and HDKD (Hierarchical Deterministic Key Derivation) Demo

Here are subkey examples for reference on use.
Compliments the formal documentation [found here](https://github.com/paritytech-stg/polkadot-sdk/tree/master/substrate/bin/utils/subkey#subkey).
Compliments the formal documentation [found here](https://github.com/paritytech/polkadot-sdk/tree/master/substrate/bin/utils/subkey#subkey).

## Key Generation

Expand Down
2 changes: 1 addition & 1 deletion content/frame/extensions/slides.md
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ fn pre_dispatch() -> Result<Self::Pre, TransactionValidityError>;
## Post Dispatch

- The dispatch result, plus generic type (`type Pre`) returned from `pre_dispatch` is passed to `post_dispatch`.
- See [`impl Applyable for CheckedExtrinsic`](https://github.com/paritytech-stg/polkadot-sdk/blob/bc53b9a/substrate/primitives/runtime/src/generic/checked_extrinsic.rs#L69) for more info.
- See [`impl Applyable for CheckedExtrinsic`](https://github.com/paritytech/polkadot-sdk/blob/bc53b9a/substrate/primitives/runtime/src/generic/checked_extrinsic.rs#L69) for more info.

---

Expand Down
2 changes: 1 addition & 1 deletion content/frame/migrations/slides.md
Original file line number Diff line number Diff line change
Expand Up @@ -359,7 +359,7 @@ impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {
}
```

Stores the version as u16 in [`twox(pallet_name) ++ twox(:__STORAGE_VERSION__:)`](https://github.com/paritytech-stg/polkadot-sdk/blob/c7c5fc7/substrate/frame/support/src/traits/metadata.rs#L163).
Stores the version as u16 in [`twox(pallet_name) ++ twox(:__STORAGE_VERSION__:)`](https://github.com/paritytech/polkadot-sdk/blob/c7c5fc7/substrate/frame/support/src/traits/metadata.rs#L163).

---

Expand Down
2 changes: 1 addition & 1 deletion content/polkadot/build-a-parachain/slides.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> _NOTE_ this is using the archived repo of the Polkadot v1.0.0 release.

<!-- FIXME update to https://github.com/paritytech-stg/polkadot-sdk/ next time -->
<!-- FIXME update to https://github.com/paritytech/polkadot-sdk/ next time -->

---

Expand Down Expand Up @@ -195,7 +195,7 @@
Make the state of the Parachain a fixed sized 2d field (e.g. 25x25) that evolves at each block according to Game of Life and print the state at each block.

- <https://en.wikipedia.org/wiki/Conway%27s_Game_of_Life>
- <https://www.rosettacode.org/wiki/Conway%27s_Game_of_Life>

Check warning on line 198 in content/polkadot/build-a-parachain/slides.md

View workflow job for this annotation

GitHub Actions / ci-checks

link checker warning

https://www.rosettacode.org/wiki/Conway%27s_Game_of_Life. Request was redirected to https://rosettacode.org/wiki/Conway%27s_Game_of_Life

---

Expand Down
4 changes: 2 additions & 2 deletions content/polkadot/cumulus/slides.md
Original file line number Diff line number Diff line change
Expand Up @@ -682,7 +682,7 @@ The relay chain needs a fairly hard guarantee that PVFs can be compiled within a

Notes:

<https://github.com/paritytech-stg/polkadot-sdk/blob/9aa7526/cumulus/docs/overview.md#runtime-upgrade>
<https://github.com/paritytech/polkadot-sdk/blob/9aa7526/cumulus/docs/overview.md#runtime-upgrade>

---

Expand Down Expand Up @@ -710,7 +710,7 @@ Reference: <https://paritytech.github.io/polkadot/book/pvf-prechecking.html>
## References

1. 🦸 [Gabriele Miotti](https://github.com/gabriele-0201), who was a huge help putting together these slides
1. <https://github.com/paritytech-stg/polkadot-sdk/blob/9aa7526/cumulus/docs/overview.md>
1. <https://github.com/paritytech/polkadot-sdk/blob/9aa7526/cumulus/docs/overview.md>

---

Expand Down
2 changes: 0 additions & 2 deletions content/security/infrastucutre/slides.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@

<img rounded style="width: 1400px" src="./img/hetzner.png" />

[Web source: Reddit](https://www.reddit.com/r/hetzner/comments/wucxs4/comment/ilfoj8u/)

Check warning on line 120 in content/security/infrastucutre/slides.md

View workflow job for this annotation

GitHub Actions / ci-checks

link checker warning

https://www.reddit.com/r/hetzner/comments/wucxs4/comment/ilfoj8u/. Request was redirected to https://www.reddit.com/r/hetzner/comments/wucxs4/comment/ilfoj8u/?rdt=41371

Notes:

Expand Down Expand Up @@ -161,8 +161,6 @@

<img rounded style="width: 600px" src="./img/rack.png" />

[Web Source: some hosting provider](https://www.datacenter-insider.de/wohlfuehlklima-fuer-rechenzentren-a-352014/)

Notes:

It is a joke of course, but how the provider engineer can see your web3 server.
Expand Down
2 changes: 1 addition & 1 deletion content/substrate/intro/slides.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ duration: 60 minutes

While I speak, please clone `polkadot-sdk`, and run `cargo build && cargo build --release`.

> <https://github.com/paritytech-stg/polkadot-sdk/>
> <https://github.com/paritytech/polkadot-sdk/>

---

Expand Down
2 changes: 1 addition & 1 deletion content/xcm/beyond/slides.md
Original file line number Diff line number Diff line change
Expand Up @@ -514,7 +514,7 @@ During this presentation we went through a couple real world XCM use cases and s

## References

- [XCM source code](https://github.com/paritytech-stg/polkadot-sdk/tree/master/polkadot/xcm) - The source code for the main XCM implementation in the paritytech/polkadot repository.
- [XCM source code](https://github.com/paritytech/polkadot-sdk/tree/master/polkadot/xcm) - The source code for the main XCM implementation in the paritytech/polkadot repository.

<!-- FIXME new repo expected soon for XCM outside SDK -->

Expand Down
2 changes: 1 addition & 1 deletion content/xcm/config/slides.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ pub trait DescribeLocation {

Notes:

[Impl for Tuple](https://github.com/paritytech-stg/polkadot-sdk/blob/342d720/polkadot/xcm/xcm-builder/src/location_conversion.rs#L34)
[Impl for Tuple](https://github.com/paritytech/polkadot-sdk/blob/342d720/polkadot/xcm/xcm-builder/src/location_conversion.rs#L34)

---v

Expand Down
2 changes: 1 addition & 1 deletion content/xcm/intro/slides.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ We are expecting them to say transfers, but there are so many other things you c
- Cross-consensus asset transfers
- Execute platform-specific actions such as governance voting
- Enables single use-case chains
- [Collectives](https://github.com/paritytech-stg/polkadot-sdk/tree/f8115b9/cumulus/parachains/runtimes/collectives)
- [Collectives](https://github.com/paritytech/polkadot-sdk/tree/72c4535/cumulus/parachains/runtimes/collectives)
- Identity chains

Notes:
Expand Down
2 changes: 1 addition & 1 deletion content/xcm/pallet/slides.md
Original file line number Diff line number Diff line change
Expand Up @@ -471,7 +471,7 @@ Notes:

Let's jump into the code and have a look at `limited_teleport_assets` extrinsic.

[source 🔍](https://github.com/paritytech-stg/polkadot-sdk/blob/342d720/polkadot/xcm/pallet-xcm/src/lib.rs#L1099)
[source 🔍](https://github.com/paritytech/polkadot-sdk/blob/342d720/polkadot/xcm/pallet-xcm/src/lib.rs#L1099)

---

Expand Down
2 changes: 1 addition & 1 deletion content/xcm/polkadot/slides.md
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ Notes:
### 🏋️ `Weigher` in Rococo

- Uses `WeightInfoBounds` with benchmarked values with `pallet-xcm-benchmarks`
- Full list of weights can be seen [here](https://github.com/paritytech-stg/polkadot-sdk/tree/cc9f812/polkadot/runtime/rococo/src/weights/xcm)
- Full list of weights can be seen [here](https://github.com/paritytech/polkadot-sdk/tree/cc9f812/polkadot/runtime/rococo/src/weights/xcm)

```rust
impl xcm_executor::Config for XcmConfig {
Expand Down
Loading