mirror of
https://github.com/ethereum/go-ethereum.git
synced 2026-06-21 06:04:33 +00:00
c6c85589af
## Why this should be merged
Signs commits for auto-renaming the Go module, originally introduced in
#51 with unsigned commits that can't be merged to `main`.
## How this works
Changes the commit action to use
[`ghcommit`](https://github.com/planetscale/ghcommit), which was made
specifically to allow for keyless signing (GitHub signs the commit). The
workflow no longer opens a PR to the `renamed-go-module` branch as it's
redundant and the generated branch can be used directly.
The commit message includes the `workflow_dispatch` trigger branch as
well as a hash of the workflow file for a complete audit trail.
I removed the commented-out PR trigger as it's unnecessary. In
development we can now just trigger the workflow on the dev branch.
## How this was tested
Inspecting [the
commit](572b8ab74e)
generated by a [workflow
run](https://github.com/ava-labs/libevm/actions/runs/11357025696/job/31589219847).
It is identical in modifications to the one reviewed in #59.
76 lines
2.7 KiB
YAML
76 lines
2.7 KiB
YAML
name: Rename Go module
|
|
|
|
on:
|
|
workflow_dispatch:
|
|
inputs:
|
|
source_commit:
|
|
description: 'Upstream commit on which to base module renaming'
|
|
required: true
|
|
type: string
|
|
default: '2bd6bd01d2e8561dd7fc21b631f4a34ac16627a1'
|
|
|
|
jobs:
|
|
rename-module:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
with:
|
|
fetch-depth: 0 # everything
|
|
|
|
- name: Set variables
|
|
id: vars
|
|
# Including hashes of both the source commit and the workflow file makes
|
|
# this idempotent.
|
|
env:
|
|
WORKFLOW_HASH: ${{ hashFiles('.github/workflows/rename-module.yml') }}
|
|
run: |
|
|
echo "WORKFLOW_HASH=${WORKFLOW_HASH}" >> "$GITHUB_OUTPUT";
|
|
echo "DEST_BRANCH=auto-rename-module_source-${{ inputs.source_commit }}_workflow-${WORKFLOW_HASH}-${{ github.ref_name }}" \
|
|
>> "$GITHUB_OUTPUT";
|
|
|
|
- name: Check out source commit
|
|
run: git checkout ${{ inputs.source_commit }}
|
|
|
|
- name: Globally update module name
|
|
run: |
|
|
go mod edit -module github.com/ava-labs/libevm;
|
|
find . -iname '*.go' -o -iname '*.txt' | xargs sed -i -E \
|
|
's|(["`]github\.com/)ethereum/go-ethereum|\1ava-labs/libevm|g';
|
|
|
|
- name: Remnant references
|
|
run: |
|
|
find . -type f | \
|
|
xargs grep -In github.com/ethereum/go-ethereum | \
|
|
grep -v "https://github.com/ethereum/go-ethereum"
|
|
|
|
- name: Set up Go
|
|
uses: actions/setup-go@v5
|
|
with:
|
|
go-version: 1.21.4
|
|
|
|
- name: Smoke tests
|
|
# `go list` shows us the module name and grep will non-zero exit on mismatch
|
|
# `go build` is a rudimentary but broad test of correctness
|
|
# The explicitly tested packages are edge cases:
|
|
# - bind generates tests and a go.mod on the fly
|
|
# - rlpgen has testdata with imports that need updating
|
|
run: |
|
|
go list . | grep ava-labs/libevm;
|
|
go build ./...;
|
|
go test ./accounts/abi/bind ./rlp/rlpgen
|
|
|
|
- name: Create new branch
|
|
env:
|
|
BRANCH: ${{ steps.vars.outputs.DEST_BRANCH }}
|
|
run: |
|
|
git checkout -b "${BRANCH}";
|
|
git push origin "${BRANCH}";
|
|
|
|
- name: Commit to new branch
|
|
uses: planetscale/ghcommit-action@d4176bfacef926cc2db351eab20398dfc2f593b5 # v0.2.0
|
|
env:
|
|
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
|
|
with:
|
|
commit_message: "[AUTO] rename Go module + update internal import paths\n\nWorkflow: ${{ steps.vars.outputs.WORKFLOW_HASH }} on branch ${{ github.ref_name }}"
|
|
repo: ${{ github.repository }}
|
|
branch: ${{ steps.vars.outputs.DEST_BRANCH }}
|