Skip to content

Commit

Permalink
Website : Created Website Pages from EIPS and ERCs page.
Browse files Browse the repository at this point in the history
  • Loading branch information
dhanushlnaik committed Jan 4, 2024
1 parent 279c674 commit 34c6864
Show file tree
Hide file tree
Showing 85 changed files with 9,306 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .bundle/config
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
BUNDLE_FROZEN: "false"
7 changes: 7 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# GitHub highlighting for Solidity files
# See https://github.com/github/linguist/pull/3973#issuecomment-357507741
*.sol linguist-language=Solidity

# Force Linux line endings on all files
# Necessary for running eipw locally
* text=auto eol=lf
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @eip-review-bot
3 changes: 3 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Please review [EIP-1](https://eips.ethereum.org/EIPS/eip-1) for EIP guidelines.

<!-- RATIONALE FOR THIS FILE: IT IS DISPLAYED WHEN YOU CREATE AN ISSUE OR MAKE A PR -->
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
ATTENTION! If you would like to submit an ERC and it has already been written as a draft (see the [template](https://github.com/ethereum/EIPs/blob/master/eip-template.md) for an example), please submit it as a [Pull Request](https://github.com/ethereum/EIPs/pulls).

If you are considering a proposal but would like to get some feedback on the idea before submitting a draft, then continue opening an Issue as a thread for discussion. Note that the more clearly and completely you state your idea the higher the quality of the feedback you are likely to receive.

Keep in mind the following guidelines from [EIP-1](https://eips.ethereum.org/EIPS/eip-1):

> Each ERC must have a champion - someone who writes the ERC using the style and format described below, shepherds the discussions in the appropriate forums, and attempts to build community consensus around the idea. The EIP champion (a.k.a. Author) should first attempt to ascertain whether the idea is ERC-able. Posting to the the Protocol Discussion forum or opening an Issue is the best way to go about this.
> Vetting an idea publicly before going as far as writing a ERC is meant to save the potential author time. Asking the Ethereum community first if an idea is original helps prevent too much time being spent on something that is guaranteed to be rejected based on prior discussions (searching the Internet does not always do the trick). It also helps to make sure the idea is applicable to the entire community and not just the author. Just because an idea sounds good to the author does not mean it will work for most people in most areas where Ethereum is used.
> Once the champion has asked the Ethereum community as to whether an idea has any chance of acceptance, a draft ERC should be presented as a Pull Request. This gives the author a chance to flesh out the draft ERC to make properly formatted, of high quality, and to address initial concerns about the proposal.
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Bug Report
description: File a bug report
labels: ['bug']

body:
- type: markdown
attributes:
value: Thanks for taking the time to fill out this bug report!
- type: input
id: pull-request
attributes:
label: Pull Request
description: Link to the pull request where the issue occurred
validations:
required: false
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
placeholder: Tell us what you see!
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Do you want to discuss EIP ideas or ask questions about the process?
url: https://ethereum-magicians.org/
about: Use the Fellowship of Ethereum Magicians for EIP-related discussion!
8 changes: 8 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
When opening a pull request to submit a new EIP, please use the suggested template: https://github.com/ethereum/EIPs/blob/master/eip-template.md

We have a GitHub bot that automatically merges some PRs. It will merge yours immediately if certain criteria are met:

- The PR edits only existing draft PRs.
- The build passes.
- Your GitHub username or email address is listed in the 'author' header of all affected PRs, inside <triangular brackets>.
- If matching on email address, the email address is the one publicly listed on your GitHub profile.
17 changes: 17 additions & 0 deletions .github/renovate.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": [
"config:base",
":disableDependencyDashboard"
],
"prConcurrentLimit": 100,
"ignorePaths": [
"**/assets/**"
],
"ignoreDeps": [
"Pandapip1/jekyll-label-action",
"ethereum/eipw-action",
"ethereum/eip-review-bot",
"ethereum/EIP-Bot"
]
}
32 changes: 32 additions & 0 deletions .github/workflows/auto-review-bot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
on:
workflow_run:
workflows:
- Auto Review Bot Trigger
types:
- completed

name: Auto Review Bot
jobs:
auto-review-bot:
runs-on: ubuntu-latest
name: Run
steps:
- name: Fetch PR Number
uses: dawidd6/action-download-artifact@246dbf436b23d7c49e21a7ab8204ca9ecd1fe615
with:
name: pr-number
workflow: auto-review-trigger.yml
run_id: ${{ github.event.workflow_run.id }}

- name: Save PR Number
id: save-pr-number
run: echo "pr=$(cat pr-number.txt)" >> $GITHUB_OUTPUT

- name: Auto Review Bot
id: auto-review-bot
uses: ethereum/eip-review-bot@dist
continue-on-error: true
with:
token: ${{ secrets.TOKEN }}
config: config/eip-editors.yml
pr_number: ${{ steps.save-pr-number.outputs.pr }}
63 changes: 63 additions & 0 deletions .github/workflows/auto-review-trigger.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
on:
pull_request_target:
pull_request_review:
workflow_dispatch:
inputs:
pr_number:
description: Pull Request Number
type: string
required: true
issue_comment:
types:
- created

concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true

name: Auto Review Bot Trigger
jobs:
trigger:
runs-on: ubuntu-latest
name: Trigger
steps:
- name: Stop Bot Recursion
run: exit 1
if: (endsWith(github.event.sender.login, '-bot') || endsWith(github.event.sender.login, '[bot]')) && github.event.sender.login != 'renovate[bot]'

- name: Write PR Number - PR Target
run: echo $PR_NUMBER > pr-number.txt
if: github.event_name == 'pull_request_target'
env:
PR_NUMBER: ${{ github.event.number }}

- name: Write PR Number - PR Review
run: echo $PR_NUMBER > pr-number.txt
if: github.event_name == 'pull_request_review'
env:
PR_NUMBER: ${{ github.event.pull_request.number }}

- name: Write PR Number - Workflow Dispatch
run: echo $PR_NUMBER > pr-number.txt
if: github.event_name == 'workflow_dispatch'
env:
PR_NUMBER: ${{ inputs.pr_number }}

- name: Write PR Number - Comment Retrigger
run: echo $PR_NUMBER > pr-number.txt
if: github.event_name == 'issue_comment' && github.event.issue.pull_request && contains(github.event.comment.body, '@eth-bot rerun')
env:
PR_NUMBER: ${{ github.event.issue.number }}

- name: Check File Existence
uses: andstor/file-existence-action@20b4d2e596410855db8f9ca21e96fbe18e12930b
id: check_pr_number_exists
with:
files: pr-number.txt

- name: Save PR Number
uses: actions/upload-artifact@65d862660abb392b8c4a3d1195a2108db131dd05
if: steps.check_pr_number_exists.outputs.files_exists == 'true'
with:
name: pr-number
path: pr-number.txt
24 changes: 24 additions & 0 deletions .github/workflows/auto-stagnate-bot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
on:
schedule:
# A job that runs every sunday at 00:00
- cron: '0 0 * * 0'
workflow_dispatch:

name: Auto Stagnant Bot
jobs:
auto_merge_bot:
if: github.repository == 'ethereum/eips'
runs-on: ubuntu-latest
name: Auto Stagnant Bot
steps:
- name: Checkout
uses: actions/checkout@47fbe2df0ad0e27efb67a70beac3555f192b062f
- name: Setup Node.js Environment
uses: actions/setup-node@d98fa1113850e562f83c7fc3a89c0ecd7a87fbed
with:
node-version: '14'
- name: auto-stagnant-bot
uses: ethereum/EIP-Bot@b3ac0ba3600aea27157fc68d1e36c08cc5a6db77 # mark-eips-stale
id: auto-stagnant-bot
with:
GITHUB-TOKEN: ${{ secrets.TOKEN }}
171 changes: 171 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,171 @@
name: Continuous Integration

on:
pull_request:
types:
- opened
- reopened
- synchronize
- ready_for_review
- edited

concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true

jobs:
save-pr:
name: Save PR Number
runs-on: ubuntu-latest

steps:
- name: Save PR number
env:
PR_NUMBER: ${{ github.event.number }}
PR_SHA: ${{ github.event.pull_request.head.sha }}
MERGE_SHA: ${{ github.sha }}
run: |
mkdir -p ./pr
echo $PR_NUMBER > ./pr/pr_number
echo $PR_SHA > ./pr/pr_sha
echo $MERGE_SHA > ./pr/merge_sha
- name: Upload PR Number
uses: actions/upload-artifact@65d862660abb392b8c4a3d1195a2108db131dd05
with:
name: pr_number
path: pr/

htmlproofer:
name: HTMLProofer
runs-on: ubuntu-20.04

steps:
- name: Checkout EIPs
uses: actions/checkout@v4
with:
repository: ethereum/EIPs
path: ''
- name: Checkout ERCs
uses: actions/checkout@v4
with:
repository: ethereum/ERCs
path: ERCs
- name: Merge Repos
run: |
mkdir -p $GITHUB_WORKSPACE/ERCs/ERCS
mkdir -p $GITHUB_WORKSPACE/ERCs/EIPS
cp -rp $GITHUB_WORKSPACE/ERCs/ERCS/. $GITHUB_WORKSPACE/EIPS
cp -rp $GITHUB_WORKSPACE/ERCs/EIPS/. $GITHUB_WORKSPACE/EIPS
cp -rp $GITHUB_WORKSPACE/ERCs/assets/. $GITHUB_WORKSPACE/assets
cd $GITHUB_WORKSPACE/EIPS
find . -name "erc-*.md" -type f -exec sh -c 'echo mv "$1" "$(echo "$1" | sed s/erc/eip/)"' _ {} \; | sh
cd $GITHUB_WORKSPACE/assets
find . -name "erc-*" -type d -exec sh -c 'echo mv "$1" "$(echo "$1" | sed s/erc/eip/)"' _ {} \; | sh
cd $GITHUB_WORKSPACE
rm -rf ERCs
- name: Setup Ruby
uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
with:
ruby-version: '3.1' # Not needed with a .ruby-version file
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
cache-version: 0 # Increment this number if you need to re-download cached gems
- name: Build with Jekyll
run: bundle exec jekyll build
env:
JEKYLL_ENV: production

- name: Build Website
run: |
bundle exec jekyll doctor
bundle exec jekyll build
- name: HTML Proofer
run: bundle exec htmlproofer --allow-missing-href --disable-external --assume-extension '.html' --log-level=:info --cache='{"timeframe":{"external":"6w"}}' --checks 'Links,Images,Scripts,OpenGraph' --no-check-sri --ignore-empty-alt --no-enforce_https ./_site
- name: DNS Validator
run: bundle exec github-pages health-check

link-check:
name: Link Check
runs-on: ubuntu-latest

steps:
- name: Checkout EIP Repository
uses: actions/checkout@47fbe2df0ad0e27efb67a70beac3555f192b062f

- name: Link Checker
uses: gaurav-nelson/github-action-markdown-link-check@d53a906aa6b22b8979d33bc86170567e619495ec
with:
config-file: config/mlc_config.json
use-quiet-mode: no
use-verbose-mode: yes
check-modified-files-only: yes

codespell:
name: CodeSpell
runs-on: ubuntu-latest

steps:
- name: Checkout EIP Repository
uses: actions/checkout@47fbe2df0ad0e27efb67a70beac3555f192b062f

- name: Get Changed Files
id: changed
continue-on-error: true
run: |
echo "CHANGED_FILES<<EOF" >> $GITHUB_ENV
gh pr diff ${{ github.event.number }} --name-only | sed -e 's|$|,|' | xargs -i echo "{}" >> $GITHUB_ENV
echo "EOF" >> $GITHUB_ENV
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Run CodeSpell
uses: codespell-project/actions-codespell@57beb9f38f49d773d641ac555d1565c3b6a59938
if: steps.changed.outcome == 'success'
with:
check_filenames: true
ignore_words_file: config/.codespell-whitelist
path: ${{ env.CHANGED_FILES }}
skip: .git,Gemfile.lock,**/*.png,**/*.gif,**/*.jpg,**/*.svg,.codespell-whitelist,vendor,_site,_config.yml,style.css

eipw-validator:
name: EIP Walidator
runs-on: ubuntu-latest

steps:
- name: Checkout EIP Repository
uses: actions/checkout@47fbe2df0ad0e27efb67a70beac3555f192b062f

- uses: ethereum/eipw-action@6785fa283773db4819cb0abf17a185a1d9b6eb9f
id: eipw
with:
token: ${{ secrets.GITHUB_TOKEN }}
unchecked: 1
path: ERCS/
options-file: config/eipw.toml

markdownlint:
name: Markdown Linter
runs-on: ubuntu-latest
steps:
- name: Checkout EIP Repository
uses: actions/checkout@47fbe2df0ad0e27efb67a70beac3555f192b062f

- name: Get Changed Files
id: changed
continue-on-error: true
run: |
echo "CHANGED_FILES<<EOF" >> $GITHUB_ENV
gh pr diff ${{ github.event.number }} --name-only | grep -E -x '[^/]+\.md|EIPS/eip-[0-9]+\.md' >> $GITHUB_ENV
echo "EOF" >> $GITHUB_ENV
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Lint
uses: DavidAnson/markdownlint-cli2-action@f5cf187ef11bd3a68a127321b794aa252ff23019
if: steps.changed.outcome == 'success'
with:
command: config
globs: |
config/.markdownlint.yaml
${{ env.CHANGED_FILES }}
Loading

0 comments on commit 34c6864

Please sign in to comment.