From b9c5881d320bdff92e245846e34d31353094118a Mon Sep 17 00:00:00 2001 From: RealiCZ Date: Fri, 20 Nov 2026 16:48:41 +0800 Subject: [PATCH 1/5] ci: pause crates.io publishing The OP crates are pinned to a git revision and cargo publish rejects git dependencies, so the crates job in the release workflow could only fail. The job is removed, and the install docs now point at release tags. --- .claude/skills/bump-version-release/SKILL.md | 5 +- .github/workflows/on-release.yml | 60 ++++---------------- Cargo.toml | 2 +- README.md | 6 +- REVIEW.md | 6 +- bin/mega-evme/README.md | 6 +- 6 files changed, 25 insertions(+), 60 deletions(-) diff --git a/.claude/skills/bump-version-release/SKILL.md b/.claude/skills/bump-version-release/SKILL.md index b5f6ffbb3..209f5049b 100644 --- a/.claude/skills/bump-version-release/SKILL.md +++ b/.claude/skills/bump-version-release/SKILL.md @@ -16,9 +16,10 @@ Releases are made by the org release pipeline (megaeth-labs/.github). Two decisi To regenerate it after a changelog edit, `gh workflow run release-settle.yml --ref main -f version=X.Y.Z` — the workflow's only input is `version`; the commit, release branch and version file are computed by the route and the action, so pass no `commit`. Merging the settle PR is the settlement decision. 3. **Publish** — merging the settle PR pushes to `release-vX.Y.Z`, which routes to `publish`. That job runs in the `release` environment and waits for its reviewer, then creates the annotated tag `vX.Y.Z` on the merge commit and publishes the GitHub Release with the settle PR's notes. The dispatch is not the approval; the merge plus the environment reviewer is. -4. **Targets** — automatic on the Release: `on-release.yml` publishes the four crates to crates.io and uploads `mega-evme` to the MegaETH artifact registry and the Release page, in the `release` environment. +4. **Targets** — automatic on the Release: `on-release.yml` uploads `mega-evme` to the MegaETH artifact registry and the Release page, in the `release` environment. + crates.io publishing is paused while the OP crates are git-pinned (see the root `Cargo.toml`), so no crates are published. Rehearse it first on an existing tag, dispatching on that tag's ref: `gh workflow run on-release.yml --ref vX.Y.Z -f dry_run=true`. The tag being released is always the run's own ref; there is no separate tag input. - The publish credentials — `CARGO_REGISTRY_TOKEN` and `GCP_AUTH_KEY` — live in the `release` environment, whose deployment policy admits `main`, `release-v*` branches and `v*` tags. + The publish credential, `GCP_AUTH_KEY`, lives in the `release` environment, whose deployment policy admits `main`, `release-v*` branches and `v*` tags. Do not create tags or Releases by hand; the tag ruleset rejects it. diff --git a/.github/workflows/on-release.yml b/.github/workflows/on-release.yml index 90d48731d..bcd1f911d 100644 --- a/.github/workflows/on-release.yml +++ b/.github/workflows/on-release.yml @@ -5,19 +5,23 @@ name: On Release # and on demand for a rehearsal: dispatch with an existing tag and # dry_run=true runs every job with nothing published, uploaded or attached. # -# Targets, as independent jobs so one hiccup never blocks the other: -# crates — the four published crates to crates.io (replaces publish.yml) +# Target: # mega-evme — the CLI binary to the MegaETH artifact registry and, as a # download for the public, to the GitHub Release page # -# Rehearse on a tag ref (these jobs must run on a tag ref): +# crates.io publishing is paused. The OP crates are pinned to a git revision +# (see the root Cargo.toml), and `cargo publish` rejects git dependencies, so +# no crates are published. To resume once those crates are on crates.io, +# restore the `crates` job from the commit that removed it. +# +# Rehearse on a tag ref (the job must run on a tag ref): # gh workflow run on-release.yml --ref vX.Y.Z -f dry_run=true # The tag being released is always the run's own ref: the environment # authorises that ref, so nothing else may be checked out or published. # -# Credentials (CARGO_REGISTRY_TOKEN, GCP_AUTH_KEY) live in the `release` -# environment, whose deployment policy admits the default branch, release -# branches and v* tags; both jobs below run in it. +# Credentials (GCP_AUTH_KEY) live in the `release` environment, whose +# deployment policy admits the default branch, release branches and v* +# tags; the job below runs in it. on: release: @@ -49,50 +53,6 @@ env: DRY_RUN: ${{ github.event_name == 'workflow_dispatch' && inputs.dry_run || false }} jobs: - crates: - runs-on: ubuntu-24.04 - timeout-minutes: 40 - environment: release - steps: - - name: Require a tag ref - run: | - [[ "$GITHUB_REF_TYPE" == "tag" ]] || { echo "::error::this workflow publishes the run's own ref, which must be a tag (got $GITHUB_REF_TYPE $GITHUB_REF_NAME); dispatch it with --ref vX.Y.Z"; exit 1; } - - - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4 - with: - ref: ${{ env.TAG }} - submodules: recursive - persist-credentials: false - - - uses: actions-rust-lang/setup-rust-toolchain@166cdcfd11aee3cb47222f9ddb555ce30ddb9659 # v1 - with: - cache: false - - - uses: foundry-rs/foundry-toolchain@b00af27efadbc7b4ca8b82abbd903b17cc874d2a # v1 - - # Packaging fails fast on manifests crates.io would reject — e.g. git-pinned - # dependencies without a registry version — before anything is uploaded. Without this - # check a multi-crate publish can upload the first crates and then fail midway, leaving a - # partial release on crates.io. Keep the list in step with the allowlist below. - - name: Pre-flight packaging check - run: | - for crate in mega-system-contracts mega-evm mega-state-test mega-evme; do - cargo package -p "$crate" --no-verify --locked - done - - - uses: megaeth-labs/.github/.github/actions/release-publish-rust-crates@main - with: - # Explicit allowlist: state-test is publish = false; mega-t8n is not published. - crates: | - mega-system-contracts - mega-evm - mega-state-test - mega-evme - version: ${{ env.TAG }} - # A rehearsal never needs the token; do not hand it to the job at all. - token: ${{ env.DRY_RUN != 'true' && secrets.CARGO_REGISTRY_TOKEN || '' }} - dry_run: ${{ env.DRY_RUN }} - mega-evme: runs-on: ubuntu-24.04 timeout-minutes: 40 diff --git a/Cargo.toml b/Cargo.toml index 8808419c4..6a0604fd8 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -135,7 +135,7 @@ mega-system-contracts = { path = "./crates/system-contracts", version = "1.7.3", # since taking these crates over (its `op-revm` still carries 20.0.0, which on crates.io targets # revm 38 — so a `version` alongside `git` would resolve to an incompatible crate). GitHub tags # are the release channel until the monorepo's crate versions move past the handed-over ones; -# the publish workflow's pre-flight check aborts a crates.io release before any upload. +# until then on-release.yml publishes no crates, and crates.io stays at 1.7.2. op-revm = { git = "https://github.com/ethereum-optimism/optimism", rev = "f67d87cd5c9992b62d215c043917b94e3f019629", default-features = false } revm = { version = "=40.0.3", default-features = false } revm-inspectors = { version = "=0.40.1", default-features = false } diff --git a/README.md b/README.md index 9c4e5307b..8ff7163bc 100644 --- a/README.md +++ b/README.md @@ -15,10 +15,12 @@ A specialized Ethereum Virtual Machine (EVM) implementation tailored for MegaETH ## Installation -Install the CLI tool from crates.io: +crates.io publishing is paused, and the last release there is 1.7.2. +Install the CLI tool from a release tag instead, taking the latest tag from [Releases](https://github.com/megaeth-labs/mega-evm/releases). +This builds from the repository, so it needs Foundry (`forge`) on `PATH`. ```bash -cargo install mega-evme --locked +cargo install --git https://github.com/megaeth-labs/mega-evm --tag vX.Y.Z --locked mega-evme ``` The `--locked` flag ensures the exact tested dependency versions are used. diff --git a/REVIEW.md b/REVIEW.md index b37e149c3..dc55cac7e 100644 --- a/REVIEW.md +++ b/REVIEW.md @@ -45,9 +45,9 @@ This is the single most important correctness concern in mega-evm. Follow the existing pattern: `#[cfg(not(feature = "std"))] use alloc as std;`. - New workspace dependencies should use `default-features = false` — features are opted-in explicitly. - **Release-blocking dependencies.** - A crate that gets published must not depend on an unpublished crate. - `cargo publish -p --locked --dry-run` has to resolve at release time. - Flag a new dependency that would break the next release's resolution. + crates.io publishing is paused while the OP crates are git-pinned (see the root `Cargo.toml`). + When it resumes, a crate that gets published must not depend on an unpublished crate, and `cargo publish -p --locked --dry-run` has to resolve at release time. + Until then, flag a new git dependency outside the pinned OP set: each one is another crate that must reach a registry before publishing can resume. ## Tests diff --git a/bin/mega-evme/README.md b/bin/mega-evme/README.md index af5f0c15c..b0f579673 100644 --- a/bin/mega-evme/README.md +++ b/bin/mega-evme/README.md @@ -27,10 +27,12 @@ A command-line tool for executing and debugging EVM bytecode, similar to go-ethe ## Installation -Install from crates.io: +crates.io publishing is paused, and the last release there is 1.7.2. +Install it from a release tag instead, taking the latest tag from [Releases](https://github.com/megaeth-labs/mega-evm/releases). +This builds from the repository, so it needs Foundry (`forge`) on `PATH`. ```bash -cargo install mega-evme --locked +cargo install --git https://github.com/megaeth-labs/mega-evm --tag vX.Y.Z --locked mega-evme ``` Or build from source: From 28d7270dd82aa760dd325349c4fc10d6bbfa52ca Mon Sep 17 00:00:00 2001 From: RealiCZ Date: Fri, 20 Nov 2026 16:54:48 +0800 Subject: [PATCH 2/5] ci: stop attaching mega-evme to immutable releases Releases are immutable once published and this workflow runs after publishing, so uploading the binary to the Release fails with HTTP 422. The upload step and the prebuilt-binary docs are removed, and the binary still goes to the artifact registry. --- .claude/skills/bump-version-release/SKILL.md | 3 ++- .github/workflows/on-release.yml | 23 ++++++++------------ README.md | 13 ----------- bin/mega-evme/README.md | 13 ----------- docs/mega-evme/overview.md | 13 ----------- 5 files changed, 11 insertions(+), 54 deletions(-) diff --git a/.claude/skills/bump-version-release/SKILL.md b/.claude/skills/bump-version-release/SKILL.md index 209f5049b..a0483d703 100644 --- a/.claude/skills/bump-version-release/SKILL.md +++ b/.claude/skills/bump-version-release/SKILL.md @@ -16,8 +16,9 @@ Releases are made by the org release pipeline (megaeth-labs/.github). Two decisi To regenerate it after a changelog edit, `gh workflow run release-settle.yml --ref main -f version=X.Y.Z` — the workflow's only input is `version`; the commit, release branch and version file are computed by the route and the action, so pass no `commit`. Merging the settle PR is the settlement decision. 3. **Publish** — merging the settle PR pushes to `release-vX.Y.Z`, which routes to `publish`. That job runs in the `release` environment and waits for its reviewer, then creates the annotated tag `vX.Y.Z` on the merge commit and publishes the GitHub Release with the settle PR's notes. The dispatch is not the approval; the merge plus the environment reviewer is. -4. **Targets** — automatic on the Release: `on-release.yml` uploads `mega-evme` to the MegaETH artifact registry and the Release page, in the `release` environment. +4. **Targets** — automatic on the Release: `on-release.yml` uploads `mega-evme` to the MegaETH artifact registry, in the `release` environment. crates.io publishing is paused while the OP crates are git-pinned (see the root `Cargo.toml`), so no crates are published. + Release assets are paused: Releases are immutable once published, so `on-release.yml` attaches nothing to them. Rehearse it first on an existing tag, dispatching on that tag's ref: `gh workflow run on-release.yml --ref vX.Y.Z -f dry_run=true`. The tag being released is always the run's own ref; there is no separate tag input. The publish credential, `GCP_AUTH_KEY`, lives in the `release` environment, whose deployment policy admits `main`, `release-v*` branches and `v*` tags. diff --git a/.github/workflows/on-release.yml b/.github/workflows/on-release.yml index bcd1f911d..9b2d9f61d 100644 --- a/.github/workflows/on-release.yml +++ b/.github/workflows/on-release.yml @@ -3,17 +3,21 @@ name: On Release # Publish targets for a mega-evm release. Runs when the release pipeline # publishes the GitHub Release (release-publish creates it after the tag), # and on demand for a rehearsal: dispatch with an existing tag and -# dry_run=true runs every job with nothing published, uploaded or attached. +# dry_run=true runs the job with nothing published or uploaded. # # Target: -# mega-evme — the CLI binary to the MegaETH artifact registry and, as a -# download for the public, to the GitHub Release page +# mega-evme — the CLI binary to the MegaETH artifact registry # # crates.io publishing is paused. The OP crates are pinned to a git revision # (see the root Cargo.toml), and `cargo publish` rejects git dependencies, so # no crates are published. To resume once those crates are on crates.io, # restore the `crates` job from the commit that removed it. # +# Release assets are paused as well. Releases here are immutable once +# published, and this workflow runs only after publishing, so attaching the +# binary to the Release fails (HTTP 422). The binary goes to the registry +# only until the release pipeline attaches assets before it publishes. +# # Rehearse on a tag ref (the job must run on a tag ref): # gh workflow run on-release.yml --ref vX.Y.Z -f dry_run=true # The tag being released is always the run's own ref: the environment @@ -29,13 +33,13 @@ on: workflow_dispatch: inputs: dry_run: - description: "Verify and build everything; publish, upload and attach nothing" + description: "Verify and build everything; publish and upload nothing" required: false type: boolean default: true # One run per tag: a release run and a dispatch on the same tag both end in -# uploads (`--clobber` on Release assets), so overlapping runs would race. +# a registry upload, so overlapping runs would race. # Never cancel an upload mid-flight; queue instead. concurrency: group: ${{ github.workflow }}-${{ github.ref }} @@ -57,8 +61,6 @@ jobs: runs-on: ubuntu-24.04 timeout-minutes: 40 environment: release - permissions: - contents: write # release-assets attaches to the Release steps: - name: Require a tag ref run: | @@ -104,11 +106,4 @@ jobs: version: ${{ env.TAG }} dry_run: ${{ env.DRY_RUN }} - - uses: megaeth-labs/.github/.github/actions/release-assets@main - with: - tag: ${{ env.TAG }} - files: | - target/release/mega-evme - dry_run: ${{ env.DRY_RUN }} - - run: 'echo "mega-evme ${{ env.TAG }}: registry=${{ steps.registry.outputs.status }} ${{ steps.registry.outputs.uri }} sha256=${{ steps.registry.outputs.sha256 }}"' diff --git a/README.md b/README.md index 8ff7163bc..029169def 100644 --- a/README.md +++ b/README.md @@ -31,19 +31,6 @@ Or build from source: cargo build --release -p mega-evme ``` -### Prebuilt binary - -Every release also attaches a prebuilt `mega-evme` (Linux x86_64, built on `ubuntu-24.04`) and a `SHA256SUMS` file to its [GitHub Release](https://github.com/megaeth-labs/mega-evm/releases). -Download both, verify the checksum, and make the binary executable: - -```bash -sha256sum --check --ignore-missing SHA256SUMS -chmod +x mega-evme -./mega-evme --version -``` - -The same binary is published to the MegaETH artifact registry for internal use. - ## Development This repository uses git submodules. diff --git a/bin/mega-evme/README.md b/bin/mega-evme/README.md index b0f579673..92c696114 100644 --- a/bin/mega-evme/README.md +++ b/bin/mega-evme/README.md @@ -44,19 +44,6 @@ cargo build --release -p mega-evme The `--locked` flag ensures the exact tested dependency versions are used. -### Prebuilt binary - -Every release also attaches a prebuilt `mega-evme` (Linux x86_64, built on `ubuntu-24.04`) and a `SHA256SUMS` file to its [GitHub Release](https://github.com/megaeth-labs/mega-evm/releases). -Download both, verify the checksum, and make the binary executable: - -```bash -sha256sum --check --ignore-missing SHA256SUMS -chmod +x mega-evme -./mega-evme --version -``` - -The same binary is published to the MegaETH artifact registry for internal use. - ## Commands ### run Command diff --git a/docs/mega-evme/overview.md b/docs/mega-evme/overview.md index 6e526ca38..9f65e3c5a 100644 --- a/docs/mega-evme/overview.md +++ b/docs/mega-evme/overview.md @@ -14,19 +14,6 @@ cargo build --release -p mega-evme # Binary: target/release/mega-evme ``` -### Prebuilt binary - -Every release also attaches a prebuilt `mega-evme` (Linux x86_64, built on `ubuntu-24.04`) and a `SHA256SUMS` file to its [GitHub Release](https://github.com/megaeth-labs/mega-evm/releases). -Download both, verify the checksum, and make the binary executable: - -```bash -sha256sum --check --ignore-missing SHA256SUMS -chmod +x mega-evme -./mega-evme --version -``` - -The same binary is published to the MegaETH artifact registry for internal use. - ## Commands | Command | Description | From d1e1f0c19f783dd338e8475d8fc087b04dc893f0 Mon Sep 17 00:00:00 2001 From: RealiCZ Date: Fri, 20 Nov 2026 17:12:11 +0800 Subject: [PATCH 3/5] docs: install mega-evme from GitHub The README install instructions now give the plain cargo install command from the GitHub repository, without a hand-filled tag. --- README.md | 6 ++---- bin/mega-evme/README.md | 6 ++---- 2 files changed, 4 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 029169def..49bb119d2 100644 --- a/README.md +++ b/README.md @@ -15,12 +15,10 @@ A specialized Ethereum Virtual Machine (EVM) implementation tailored for MegaETH ## Installation -crates.io publishing is paused, and the last release there is 1.7.2. -Install the CLI tool from a release tag instead, taking the latest tag from [Releases](https://github.com/megaeth-labs/mega-evm/releases). -This builds from the repository, so it needs Foundry (`forge`) on `PATH`. +Install the CLI tool from GitHub (building it requires Foundry's `forge`): ```bash -cargo install --git https://github.com/megaeth-labs/mega-evm --tag vX.Y.Z --locked mega-evme +cargo install --git https://github.com/megaeth-labs/mega-evm --locked mega-evme ``` The `--locked` flag ensures the exact tested dependency versions are used. diff --git a/bin/mega-evme/README.md b/bin/mega-evme/README.md index 92c696114..d89fcac3a 100644 --- a/bin/mega-evme/README.md +++ b/bin/mega-evme/README.md @@ -27,12 +27,10 @@ A command-line tool for executing and debugging EVM bytecode, similar to go-ethe ## Installation -crates.io publishing is paused, and the last release there is 1.7.2. -Install it from a release tag instead, taking the latest tag from [Releases](https://github.com/megaeth-labs/mega-evm/releases). -This builds from the repository, so it needs Foundry (`forge`) on `PATH`. +Install it from GitHub (building it requires Foundry's `forge`): ```bash -cargo install --git https://github.com/megaeth-labs/mega-evm --tag vX.Y.Z --locked mega-evme +cargo install --git https://github.com/megaeth-labs/mega-evm --locked mega-evme ``` Or build from source: From 27d620c9a56654bda119fb30ba14fde6ca7bb665 Mon Sep 17 00:00:00 2001 From: RealiCZ Date: Fri, 20 Nov 2026 17:19:48 +0800 Subject: [PATCH 4/5] docs: split the install instructions into two ways The Installation section now lists installing from GitHub and from a Git checkout as two plain alternatives. --- README.md | 12 +++++++----- bin/mega-evme/README.md | 13 +++++++------ 2 files changed, 14 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 49bb119d2..2b3b66f24 100644 --- a/README.md +++ b/README.md @@ -15,18 +15,20 @@ A specialized Ethereum Virtual Machine (EVM) implementation tailored for MegaETH ## Installation -Install the CLI tool from GitHub (building it requires Foundry's `forge`): +Building requires Foundry's `forge`. + +From GitHub: ```bash cargo install --git https://github.com/megaeth-labs/mega-evm --locked mega-evme ``` -The `--locked` flag ensures the exact tested dependency versions are used. - -Or build from source: +From a Git checkout: ```bash -cargo build --release -p mega-evme +git clone --recursive https://github.com/megaeth-labs/mega-evm +cd mega-evm +cargo install --locked --path bin/mega-evme ``` ## Development diff --git a/bin/mega-evme/README.md b/bin/mega-evme/README.md index d89fcac3a..c3bc88fd1 100644 --- a/bin/mega-evme/README.md +++ b/bin/mega-evme/README.md @@ -27,21 +27,22 @@ A command-line tool for executing and debugging EVM bytecode, similar to go-ethe ## Installation -Install it from GitHub (building it requires Foundry's `forge`): +Building requires Foundry's `forge`. + +From GitHub: ```bash cargo install --git https://github.com/megaeth-labs/mega-evm --locked mega-evme ``` -Or build from source: +From a Git checkout: ```bash -cargo build --release -p mega-evme -# The binary will be at target/release/mega-evme +git clone --recursive https://github.com/megaeth-labs/mega-evm +cd mega-evm +cargo install --locked --path bin/mega-evme ``` -The `--locked` flag ensures the exact tested dependency versions are used. - ## Commands ### run Command From 88e253cd3fca9c0f4628490215a0623148f3f8ce Mon Sep 17 00:00:00 2001 From: RealiCZ Date: Fri, 20 Nov 2026 17:37:51 +0800 Subject: [PATCH 5/5] docs: apply review fixes to the install and release docs Sync the mega-evme overview install section and tighten wording in the release workflow, README and release skill. --- .claude/skills/bump-version-release/SKILL.md | 2 +- .github/workflows/on-release.yml | 8 ++++---- README.md | 2 +- docs/mega-evme/overview.md | 15 +++++++++++++-- 4 files changed, 19 insertions(+), 8 deletions(-) diff --git a/.claude/skills/bump-version-release/SKILL.md b/.claude/skills/bump-version-release/SKILL.md index a0483d703..d24b3612e 100644 --- a/.claude/skills/bump-version-release/SKILL.md +++ b/.claude/skills/bump-version-release/SKILL.md @@ -19,7 +19,7 @@ Releases are made by the org release pipeline (megaeth-labs/.github). Two decisi 4. **Targets** — automatic on the Release: `on-release.yml` uploads `mega-evme` to the MegaETH artifact registry, in the `release` environment. crates.io publishing is paused while the OP crates are git-pinned (see the root `Cargo.toml`), so no crates are published. Release assets are paused: Releases are immutable once published, so `on-release.yml` attaches nothing to them. - Rehearse it first on an existing tag, dispatching on that tag's ref: `gh workflow run on-release.yml --ref vX.Y.Z -f dry_run=true`. + Rehearse `on-release.yml` first on an existing tag, dispatching on that tag's ref: `gh workflow run on-release.yml --ref vX.Y.Z -f dry_run=true`. The tag being released is always the run's own ref; there is no separate tag input. The publish credential, `GCP_AUTH_KEY`, lives in the `release` environment, whose deployment policy admits `main`, `release-v*` branches and `v*` tags. diff --git a/.github/workflows/on-release.yml b/.github/workflows/on-release.yml index 9b2d9f61d..456b63708 100644 --- a/.github/workflows/on-release.yml +++ b/.github/workflows/on-release.yml @@ -3,7 +3,7 @@ name: On Release # Publish targets for a mega-evm release. Runs when the release pipeline # publishes the GitHub Release (release-publish creates it after the tag), # and on demand for a rehearsal: dispatch with an existing tag and -# dry_run=true runs the job with nothing published or uploaded. +# dry_run=true runs the job with nothing uploaded. # # Target: # mega-evme — the CLI binary to the MegaETH artifact registry @@ -11,7 +11,7 @@ name: On Release # crates.io publishing is paused. The OP crates are pinned to a git revision # (see the root Cargo.toml), and `cargo publish` rejects git dependencies, so # no crates are published. To resume once those crates are on crates.io, -# restore the `crates` job from the commit that removed it. +# restore the `crates` job from PR #424. # # Release assets are paused as well. Releases here are immutable once # published, and this workflow runs only after publishing, so attaching the @@ -23,7 +23,7 @@ name: On Release # The tag being released is always the run's own ref: the environment # authorises that ref, so nothing else may be checked out or published. # -# Credentials (GCP_AUTH_KEY) live in the `release` environment, whose +# The credential (GCP_AUTH_KEY) lives in the `release` environment, whose # deployment policy admits the default branch, release branches and v* # tags; the job below runs in it. @@ -33,7 +33,7 @@ on: workflow_dispatch: inputs: dry_run: - description: "Verify and build everything; publish and upload nothing" + description: "Verify and build mega-evme; upload nothing" required: false type: boolean default: true diff --git a/README.md b/README.md index 2b3b66f24..877509c20 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ A specialized Ethereum Virtual Machine (EVM) implementation tailored for MegaETH ## Installation -Building requires Foundry's `forge`. +Building `mega-evme` requires Foundry's `forge`. From GitHub: diff --git a/docs/mega-evme/overview.md b/docs/mega-evme/overview.md index 9f65e3c5a..96970dd69 100644 --- a/docs/mega-evme/overview.md +++ b/docs/mega-evme/overview.md @@ -9,9 +9,20 @@ Similar to go-ethereum's `evm` command, `mega-evme` provides full control over t ## Installation +Building requires Foundry's `forge`. + +From GitHub: + +```bash +cargo install --git https://github.com/megaeth-labs/mega-evm --locked mega-evme +``` + +From a Git checkout: + ```bash -cargo build --release -p mega-evme -# Binary: target/release/mega-evme +git clone --recursive https://github.com/megaeth-labs/mega-evm +cd mega-evm +cargo install --locked --path bin/mega-evme ``` ## Commands