Skip to content

feat: signed commit when renaming upstream module #61

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

Merged
merged 3 commits into from
Oct 17, 2024
Merged

feat: signed commit when renaming upstream module #61

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
26d4fac
feat: signed commit when renaming upstream module
ARR4N Oct 15, 2024
da2eaf5
chore: lock `ghcommit-action` commit hash
ARR4N Oct 16, 2024
6c4398c
chore: include workflow-file hash in commit message
ARR4N Oct 16, 2024
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
55 changes: 25 additions & 30 deletions .github/workflows/rename-module.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,6 @@
name: Rename Go module

on:
# During development, the next two lines MAY be enabled to have the PR
# automatically run this workflow for inspection of the resulting branch.
# However, they MUST be disabled again before merging otherwise *all* PRs will
# run this.
#
# pull_request:
# branches: [ main ]
workflow_dispatch:
inputs:
source_commit:
Expand All @@ -19,18 +12,24 @@ on:
jobs:
rename-module:
runs-on: ubuntu-latest
env:
source_commit: "${{ inputs.source_commit || '2bd6bd01d2e8561dd7fc21b631f4a34ac16627a1' }}"
# env variables cannot reference others so we have to duplicate the ||
output_branch: "${{ github.ref_name }}_auto-rename-module-${{ inputs.source_commit || '2bd6bd01d2e8561dd7fc21b631f4a34ac16627a1' }}"
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0 # everything
fetch-tags: true

- 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 ${{ env.source_commit }}
run: git checkout ${{ inputs.source_commit }}

- name: Globally update module name
run: |
Expand Down Expand Up @@ -60,22 +59,18 @@ jobs:
go build ./...;
go test ./accounts/abi/bind ./rlp/rlpgen

- name: Commit to new branch
uses: devops-infra/action-commit-push@8bc2ff9f9de7aa2a7581fc7e5b6401c04cab54c7
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
target_branch: ${{ env.output_branch }}
force: true
commit_prefix: "[AUTO] rename Go module + update internal import paths"
- name: Create new branch
env:
BRANCH: ${{ steps.vars.outputs.DEST_BRANCH }}
run: |
git checkout -b "${BRANCH}";
git push origin "${BRANCH}";

- name: Open PR to "renamed-go-module" iff workflow dispatched on "main"
# If we are changing the way in which we manage module renaming then it
# MUST go through PR review to main; only then can it open PRs.
if: github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/main'
uses: devops-infra/action-pull-request@v0.5.5
- name: Commit to new branch
uses: planetscale/ghcommit-action@d4176bfacef926cc2db351eab20398dfc2f593b5 # v0.2.0
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

curious why not refer to v0.2.0?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's possible to change a version tag to a different commit so this just reduces the attack surface.

env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
source_branch: ${{ env.output_branch }}
target_branch: renamed-go-module
title: "[AUTO] Rename upstream Go module at `${{ env.source_commit }}`"
body: "_PR generated by GitHub Action_"
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 }}