Skip to content

Commit 65a1a80

Browse files
committed
Polkadot Runtime Releaser Milestone 1
Signed-off-by: Xavier Lau <[email protected]>
1 parent f00ca5f commit 65a1a80

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Milestone Delivery :mailbox:
2+
3+
**The delivery is according to the official [milestone delivery guidelines](https://github.com/w3f/Grants-Program/blob/master/docs/Support%20Docs/milestone-deliverables-guidelines.md).**
4+
5+
* **Application Document:** In the case of a public [Grants Program](https://github.com/w3f/Grants-Program) application, please provide a link to the merged contract (the `.md` file in the [applications](https://github.com/w3f/Grants-Program/tree/master/applications) directory). In the case of a private application, please provide the name of the project.
6+
* **Milestone Number:** 1
7+
8+
**Deliverables**
9+
| Number | Deliverable | Link | Notes |
10+
| -----: | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- |
11+
| 0a. | License | [GPL-3.0](https://github.com/hack-ink/polkadot-runtime-releaser/blob/main/LICENSE) and [GPL-3.0](https://github.com/hack-ink/polkadot-runtime-releaser-workshop/blob/main/LICENSE) | |
12+
| 0b. | Documentation | [README.md](https://github.com/hack-ink/polkadot-runtime-releaser/blob/main/README.md) and [README.md](https://github.com/hack-ink/polkadot-runtime-releaser-workshop/blob/main/README.md) | |
13+
| 0c. | Testing guide | Please check the "Additional Information" section below in this document | |
14+
| 1. | Docker image | [Source](https://github.com/hack-ink/polkadot-runtime-releaser/tree/main/docker) and [pre-built](https://ghcr.io/hack-ink/polkadot-runtime-releaser) | |
15+
| 2. | Try-Runtime CI | [GitHub Action](https://github.com/hack-ink/polkadot-runtime-releaser/blob/main/action/try-runtime) | |
16+
| 3. | Release CI | [GitHub Action](https://github.com/hack-ink/polkadot-runtime-releaser-workshop/blob/main/.github/workflows/release.yml) | |
17+
| 4. | WASM override tool | [Source](https://github.com/hack-ink/polkadot-runtime-releaser/blob/main/cli/src/cli/build.rs) and for the release please check at NO.7 in this table | |
18+
| 5. | WASM override CI | [GitHub Action](https://github.com/hack-ink/polkadot-runtime-releaser/blob/main/action/override) | |
19+
| 6. | WASM info inspect tool | [Source](https://github.com/hack-ink/polkadot-runtime-releaser/blob/main/cli/src/cli/inspect.rs) and for the release please check at NO.7 in this table | |
20+
| 7. | Releases | [GitHub](https://github.com/hack-ink/polkadot-runtime-releaser/releases) and [crates.io](https://crates.io/crates/polkadot-runtime-releaser-cli) | |
21+
| 8. | Workshop | [GitHub repository](https://github.com/hack-ink/polkadot-runtime-releaser-workshop) | |
22+
23+
**Additional Information**
24+
25+
Testing Guide:
26+
- Unit test
27+
```sh
28+
# Make sure you have Git and Rust installed.
29+
git clone https://github.com/hack-ink/polkadot-runtime-releaser.git
30+
cd polkadot-runtime-releaser
31+
cargo test
32+
```
33+
If you cannot set up the test environment on your local machine, you can also check the GitHub Action.
34+
I have already set up the [Clippy](https://github.com/hack-ink/polkadot-runtime-releaser/actions/runs/12524880278/job/34935843642) test and the [General](https://github.com/hack-ink/polkadot-runtime-releaser/actions/runs/12524880278/job/34935843771) test in GitHub Action.
35+
- Integration test
36+
37+
I will not elaborate on the details here, since the goal of this project is to enable the team to easily set up the release pipeline.
38+
Please check the ["Setup Guide"](https://github.com/hack-ink/polkadot-runtime-releaser?tab=readme-ov-file#setup-guide) section.
39+
I think every step and `action.yml` is well documented. If you encounter any issues, please let me know!
40+
41+
If the test is successful, you will see the such similar output:
42+
- [Polkadot Runtime](https://github.com/hack-ink/polkadot-runtime-releaser-workshop/tree/polkadot-runtime)
43+
- [Staging Kusama Runtime](https://github.com/hack-ink/polkadot-runtime-releaser-workshop/tree/staging-kusama-runtime)
44+
- [Try-Runtime](https://github.com/hack-ink/polkadot-runtime-releaser-workshop/pull/3)
45+
- [Release `v0.0.1`](https://github.com/hack-ink/polkadot-runtime-releaser-workshop/releases/tag/v0.0.1)

0 commit comments

Comments
 (0)