-
Notifications
You must be signed in to change notification settings - Fork 4
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.
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
Chore: Add forkdiff gh-page #14
Merged
Merged
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
885e467
forkdiff wip
quasystaty1 a6e51ba
Update pages.yaml
quasystaty1 1f73e9b
wip
quasystaty1 78a1b3d
fix: fix page deployment test
quasystaty1 adad1d2
small issue
quasystaty1 8987205
ref points to branch
quasystaty1 eec951f
Address feedback
quasystaty1 f15ed74
new lines
quasystaty1 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
name: Build and publish forkdiff github-pages | ||
permissions: | ||
contents: write | ||
on: | ||
pull_request: | ||
branches: | ||
- main | ||
jobs: | ||
deploy: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v3 | ||
with: | ||
fetch-depth: 1000 # make sure to fetch the old commit we diff against | ||
|
||
- name: Build forkdiff | ||
uses: "docker://protolambda/forkdiff:latest" | ||
with: | ||
args: -repo=./ -fork=./fork.yaml -out=./index.html | ||
|
||
- name: Build pages | ||
run: | | ||
mkdir -p ./tmp/pages | ||
mv ./index.html ./tmp/pages/index.html | ||
touch ./tmp/pages/.nojekyll | ||
|
||
- name: Deploy | ||
uses: peaceiris/actions-gh-pages@v3 | ||
with: | ||
github_token: ${{ secrets.GITHUB_TOKEN }} | ||
# Build output to publish to the `gh-pages` branch: | ||
publish_dir: ./tmp/pages | ||
# The following lines assign commit authorship to the official | ||
# GH-Actions bot for deploys to `gh-pages` branch: | ||
# https://github.com/actions/checkout/issues/13#issuecomment-724415212 | ||
# The GH actions bot is used by default if you didn't specify the two fields. | ||
# You can swap them out with your own user credentials. | ||
user_name: github-actions[bot] | ||
user_email: 41898282+github-actions[bot]@users.noreply.github.com | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit: newline |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,95 @@ | ||
title: "astria-geth - go-ethereum fork diff overview" | ||
footer: | | ||
Fork-diff overview of [`astria-geth`](https://github.com/astriaorg/astria-geth), a fork of [`go-ethereum`](https://github.com/ethereum/go-ethereum). | ||
base: | ||
name: go-ethereum | ||
url: https://github.com/ethereum/go-ethereum | ||
hash: 916d6a441a866cb618ae826c220866de118899f7 | ||
fork: | ||
name: astria-geth | ||
url: https://github.com/astriaorg/astria-geth | ||
ref: refs/heads/quasystaty1/forkdiff | ||
def: | ||
title: "astria-geth" | ||
description: | | ||
This is an overview of the changes in [`astria-geth`](https://github.com/astriaorg/astria-geth), | ||
a fork of [`go-ethereum`](https://github.com/ethereum/go-ethereum), part of the Astria-stack. | ||
|
||
The Astria-stack architecture is modular, following the Consensus/Execution split of post-Merge Ethereum L1: | ||
- [`astria-geth`](https://github.com/astriaorg/astria-geth) implements the Execution-Layer, with **minimal changes** for a secure Ethereum-equivalent application environment. | ||
|
||
Related [astria-stack specifications](https://github.com/astriaorg/astria/tree/main/specs): | ||
sub: | ||
- title: "Core modifications" | ||
sub: | ||
- title: "Execution API" | ||
description: | | ||
The execution implements the [execution apiֿ](https://github.com/astriaorg/astria/blob/main/specs/execution-api.md) of the shared sequencer. | ||
Its procedures will be called from the [conductor](https://github.com/astriaorg/astria/blob/main/specs/conductor.md). It is responsible | ||
for immediately executing lists of ordered transactions that come from the shared sequencer. | ||
globs: | ||
- "grpc/execution/*" | ||
- "grpc/*" | ||
- title: "Tx-pool" | ||
description: | | ||
Transactions ordering as set by the shared sequencer | ||
globs: | ||
- "core/txpool/blobpool/*" | ||
- "core/txpool/*" | ||
- "core/txpool/legacypool/*" | ||
- title: "State-transition modifications" | ||
description: "" | ||
sub: | ||
- title: "Deposit Transaction type" | ||
description: | | ||
`Deposit` transaction type enable changes to the rollup based on sequencer layer events | ||
globs: | ||
- "core/types/deposit_tx.go" | ||
- "core/types/transaction.go" | ||
- "core/state_transition.go" | ||
- "core/types/receipt.go" | ||
|
||
- title: "Block-building modifications" | ||
description: | | ||
The block-building code implements changes to support shared sequencer transactions ordering. | ||
Transactions are now being fethced from the `TxPool` based on the shared sequencer. | ||
globs: | ||
- "miner/*" | ||
- title: "Node modifications" | ||
description: Changes to the node configuration and services. | ||
sub: | ||
- title: Node config | ||
globs: | ||
- "node/config.go" | ||
- "node/defaults.go" | ||
- "node/grpcstack.go" | ||
- "node/node.go" | ||
- title: "CLI" | ||
description: | | ||
CLI changes to support grpc server. | ||
globs: | ||
- "cmd/utils/flags.go" | ||
- "cmd/geth/main.go" | ||
- "internal/flags/categories.go" | ||
- "cmd/geth/config.go" | ||
- title: "Chain Configuration" | ||
sub: | ||
- title: "Chain config" | ||
description: | | ||
Configuration changes for integrating the shared seuqnecer | ||
globs: | ||
- "params/config.go" | ||
- "params/protocol_params.go" | ||
- "core/genesis.go" | ||
- "genesis.json" | ||
- "core/blockchain.go" | ||
- "eth/backend.go" | ||
|
||
# ignored globally, does not count towards line count | ||
ignore: | ||
- ".circleci/*" | ||
- "*.sum" | ||
- "go.mod" | ||
- "fork.yaml" | ||
- ".github/*" | ||
- ".github/workflows/*" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit: newline |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we should probably use v4