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.

Sign up for GitHub

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

Polkadot Runtime Releaser Milestone 1 #1236

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+45 −0
Open

Polkadot Runtime Releaser Milestone 1 #1236

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aec269f
Polkadot Runtime Releaser Milestone 1
aurexav Dec 28, 2024
87dfc1e
Fixes
aurexav Jan 3, 2025
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
45 changes: 45 additions & 0 deletions deliveries/polkadot-runtime-releaser-milestone_1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Milestone Delivery :mailbox:

**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).**

* **Application Document:** https://github.com/w3f/Grants-Program/blob/master/applications/polkadot-runtime-releaser.md
* **Milestone Number:** 1

**Deliverables**
| Number | Deliverable | Link | Notes |
| -----: | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- |
| 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) | |
| 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) | |
| 0c. | Testing guide | Please check the "Additional Information" section below in this document | |
| 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) | |
| 2. | Try-Runtime CI | [GitHub Action](https://github.com/hack-ink/polkadot-runtime-releaser/blob/main/action/try-runtime) | |
| 3. | Release CI | [GitHub Action](https://github.com/hack-ink/polkadot-runtime-releaser-workshop/blob/main/.github/workflows/release.yml) | |
| 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 | |
| 5. | WASM override CI | [GitHub Action](https://github.com/hack-ink/polkadot-runtime-releaser/blob/main/action/override) | |
| 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 | |
| 7. | Releases | [GitHub](https://github.com/hack-ink/polkadot-runtime-releaser/releases) and [crates.io](https://crates.io/crates/polkadot-runtime-releaser-cli) | |
| 8. | Workshop | [GitHub repository](https://github.com/hack-ink/polkadot-runtime-releaser-workshop) | |

**Additional Information**

Testing Guide:
- Unit test
```sh
# Make sure you have Git and Rust installed.
git clone https://github.com/hack-ink/polkadot-runtime-releaser.git
cd polkadot-runtime-releaser
cargo test
```
If you cannot set up the test environment on your local machine, you can also check the GitHub Action.
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.
- Integration test

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.
Please check the ["Setup Guide"](https://github.com/hack-ink/polkadot-runtime-releaser?tab=readme-ov-file#setup-guide) section.
I think every step and `action.yml` is well documented. If you encounter any issues, please let me know!

If the test is successful, you will see the such similar output:
- [Polkadot Runtime](https://github.com/hack-ink/polkadot-runtime-releaser-workshop/tree/polkadot-runtime)
- [Staging Kusama Runtime](https://github.com/hack-ink/polkadot-runtime-releaser-workshop/tree/staging-kusama-runtime)
- [Try-Runtime](https://github.com/hack-ink/polkadot-runtime-releaser-workshop/pull/3)
- [Release `v0.0.1`](https://github.com/hack-ink/polkadot-runtime-releaser-workshop/releases/tag/v0.0.1)
Loading