diff --git a/.github/workflows/book.yml b/.github/workflows/book.yml new file mode 100644 index 00000000..1011b943 --- /dev/null +++ b/.github/workflows/book.yml @@ -0,0 +1,103 @@ +# Documentation and mdbook related jobs. +# Reference: https://github.com/paradigmxyz/reth/blob/main/.github/workflows/book.yml + +name: book + +on: + push: + branches: [main] + pull_request: + branches: [main] + paths: + - "book/**" + merge_group: + +jobs: + lint: + runs-on: ubuntu-latest + name: lint + timeout-minutes: 60 + + steps: + - uses: actions/checkout@v4 + + - name: Install mdbook-linkcheck + run: | + mkdir mdbook-linkcheck + curl -sSL -o mdbook-linkcheck.zip https://github.com/Michael-F-Bryan/mdbook-linkcheck/releases/latest/download/mdbook-linkcheck.x86_64-unknown-linux-gnu.zip + unzip mdbook-linkcheck.zip -d ./mdbook-linkcheck + chmod +x $(pwd)/mdbook-linkcheck/mdbook-linkcheck + echo $(pwd)/mdbook-linkcheck >> $GITHUB_PATH + + - name: Run linkcheck + run: mdbook-linkcheck --standalone + + build: + runs-on: ubuntu-latest + timeout-minutes: 60 + steps: + - uses: actions/checkout@v4 + - uses: dtolnay/rust-toolchain@nightly + - name: Install mdbook + run: | + mkdir mdbook + curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.14/mdbook-v0.4.14-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook + echo $(pwd)/mdbook >> $GITHUB_PATH + + - name: Install mdbook-template + run: | + mkdir mdbook-template + curl -sSL https://github.com/sgoudham/mdbook-template/releases/latest/download/mdbook-template-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook-template + echo $(pwd)/mdbook-template >> $GITHUB_PATH + + - uses: Swatinem/rust-cache@v2 + with: + cache-on-failure: true + + - name: Build book + run: mdbook build + + - name: Archive artifact + shell: sh + run: | + chmod -c -R +rX "target/book" | + while read line; do + echo "::warning title=Invalid file permissions automatically fixed::$line" + done + tar \ + --dereference --hard-dereference \ + --directory "target/book" \ + -cvf "$RUNNER_TEMP/artifact.tar" \ + --exclude=.git \ + --exclude=.github \ + . + + - name: Upload artifact + uses: actions/upload-artifact@v4 + with: + name: github-pages + path: ${{ runner.temp }}/artifact.tar + retention-days: 1 + if-no-files-found: error + + deploy: + # Only deploy if a push to main + if: github.ref_name == 'main' && github.event_name == 'push' + runs-on: ubuntu-latest + needs: [lint, build] + + # Grant GITHUB_TOKEN the permissions required to make a Pages deployment + permissions: + pages: write + id-token: write + + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + + timeout-minutes: 60 + + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 \ No newline at end of file diff --git a/book/getting-started/proposer.md b/book/getting-started/proposer.md index cc0d07d4..9070ea13 100644 --- a/book/getting-started/proposer.md +++ b/book/getting-started/proposer.md @@ -16,25 +16,26 @@ We've packaged the `op-succinct-proposer` service in a docker-compose file to ma Build the docker images for the `op-succinct-proposer` service. ```bash -sudo docker-compose -f docker-compose.proposer.yml build +cd proposer +sudo docker-compose build ``` ## 2) Run the Proposer This command launches the `op-succinct-proposer` service in the background. It launches two containers: one container that manages proof generation and another container that is a small fork of the original `op-proposer` service. -``` -sudo docker-compose -f docker-compose.proposer.yml up +```bash +sudo docker-compose up ``` To see the logs of the `op-succinct-proposer` service, run: ```bash -sudo docker-compose -f docker-compose.proposer.yml logs -f +sudo docker-compose logs -f ``` and to stop the `op-succinct-proposer` service, run: ```bash -sudo docker-compose -f docker-compose.proposer.yml down +sudo docker-compose down ``` \ No newline at end of file diff --git a/docker-compose.yml b/proposer/docker-compose.yml similarity index 78% rename from docker-compose.yml rename to proposer/docker-compose.yml index dc30f12e..9d2aec26 100644 --- a/docker-compose.yml +++ b/proposer/docker-compose.yml @@ -3,7 +3,7 @@ services: op-succinct-server: build: context: . - dockerfile: ./proposer/succinct/Dockerfile.server + dockerfile: ./succinct/Dockerfile env_file: - .env.server restart: unless-stopped @@ -14,7 +14,7 @@ services: op-succinct-proposer: build: context: . - dockerfile: ./proposer/op/Dockerfile.op_proposer + dockerfile: ./op/Dockerfile.op_proposer env_file: - .env.server restart: unless-stopped diff --git a/proposer/succinct/Dockerfile.server b/proposer/succinct/Dockerfile similarity index 100% rename from proposer/succinct/Dockerfile.server rename to proposer/succinct/Dockerfile