GitHub action to install Foundry

This action has been working great for me but suddenly (today) getting 404s:

Run foundry-rs/foundry-toolchain@v1
  
Error: Error: Unexpected HTTP response: 404

Rerunning old tests also breaks on tests that used to pass, so potentially something new in the latest foundry is causing an issue.

It would be super nice to be able to specify a fixed version of foundry rather than nightly to prevent these kinds of issues in the future.

Here is my pipeline:

name: Run Contract FORGE Tests

on:
  pull_request:
    paths:
      - "contracts/**/*.sol"
      - "contracts/test/**"

env:
  FOUNDRY_PROFILE: ci # This foundry profile is set to test the contracts slighly more vigorously.

defaults:
  run:
    working-directory: ./contracts

jobs:
  run-forge-contract-tests:
    name: Run contract FORGE tests
    runs-on: ubuntu-latest

    steps:
      # Checks out a copy of your repository on the ubuntu-latest machine
      - name: Checkout code
        uses: actions/checkout@v2

      - name: Cache contract node_modules
        id: cache_contracts_node_modules
        uses: actions/cache@v2
        with:
          path: ~/work/monorepo/monorepo/contracts/node_modules
          key: ${{ runner.os }}-modules-${{ hashFiles('~/work/monorepo/monorepo/contracts/yarn.lock') }}

      - name: install node packages
        if: steps.cache_contracts_node_modules.outputs.cache-hit != 'true'
        id: install_node_packages_contracts
        run: |
          yarn

      - name: Install Foundry
        uses: onbjerg/foundry-toolchain@v1
        with:
          version: nightly # Note be careful, this might break at some point! We should fix a version rather - wasn't clear what the version was though from docs at time

      - name: Cache the foundry/forge cache
        id: cache_foundry_compile
        uses: actions/cache@v2
        with:
          path: |
            ~/work/monorepo/monorepo/contracts/cache
            ~/work/monorepo/monorepo/contracts/out
          key: ${{ runner.os }}-foundry-cache-v0.8.15-${{ hashFiles('~/work/monorepo/monorepo/contracts/contracts/**') }}
          restore-keys: |
            ${{ runner.os }}-foundry-cache-v0.8.15

      - name: Install forge dependencies
        id: run_install_dependencies
        run: |
          forge install

      - name: Pre-build contracts for following steps
        id: build_contracts
        run: |
          forge build #--extra-output abi --extra-output userdoc --extra-output devdoc --extra-output evm.methodIdentifiers

      - name: Run forge tests
        id: run_forge_tests
        run: |
          forge snapshot --check # -vvvv means that all stack and setup traces are displayed

      ## No benefit to running slither in the pipeline currently... 😢
      # - name: Run Slither
      #   id: slither
      #   uses: crytic/[email protected]
      #   continue-on-error: true
      #   with:
      #     ignore-compile: true
      #     node-version: 16
      #     sarif: results.sarif

      # # TODO:  re-add this once github has enabled this feature for our account.
      # - name: Upload SARIF file
      #   id: upload-sarif-file
      #   uses: github/codeql-action/upload-sarif@v2
      #   with:
      #     sarif_file: ${{ steps.slither.outputs.sarif }}

I'm unable to replicate this failure locally, and multiple people from my team also don't have the issue locally, so it seems like it is something about how the pipeline takes the output from build.

We use the foundry-toolchain github action in our CI and it started failing recently with failures like this:

forge: /lib/x86_64-linux-gnu/libc.so.6: version `GLIBC_2.33' not found (required by forge)
forge: /lib/x86_64-linux-gnu/libc.so.6: version `GLIBC_2.32' not found (required by forge)
forge: /lib/x86_64-linux-gnu/libc.so.6: version `GLIBC_2.34' not found (required by forge)

Is there a problem with the nightly release?

Since the format of snapshot output messes slightly with the markdown output for GitHub steps summary. Related issue: https://github.com/foundry-rs/foundry/issues/3394.

updated the download url to new github org updated dependency documented new feature for generating CI report summary added build script added CI workflow for the action itself

Have been using this action for several months. Here's my config:

      - name: Install Foundry
        uses: foundry-rs/foundry-toolchain@v1
        with:
          version: nightly

Today, all builds started erroring out with this in logs:

2022-08-10T23:53:09.1613407Z ##[group]Run foundry-rs/foundry-toolchain@v1
2022-08-10T23:53:09.1613645Z with:
2022-08-10T23:53:09.1613815Z   version: nightly
2022-08-10T23:53:09.1614005Z ##[endgroup]
2022-08-10T23:53:09.7820830Z ##[error]Error: Unexpected HTTP response: 404

Rerun with debug logging, and found this:

Run foundry-rs/foundry-toolchain@v1
##[debug]Downloading https://github.com/gakonst/foundry/releases/download/nightly/foundry_nightly_linux_amd64.tar.gz
##[debug]Destination /home/runner/work/_temp/b4fac0c4-7268-4a4f-b232-bbd68e7f2f9f
##[debug]Failed to download from "https://github.com/gakonst/foundry/releases/download/nightly/foundry_nightly_linux_amd64.tar.gz". Code(404) Message(Not Found)
Error: Error: Unexpected HTTP response: 404
##[debug]Node Action run completed with exit code 1

That repo redirects to foundry-rs, but that link is unreachable. Is there a new download link for the binary?

forge fmt --check doesn't return any error on my machine. But when it comes to github action these errors are generated and the action fails

It's our github action https://github.com/Giveth/givpower/blob/4a606264587fb1a84686c95e51341c08ad712970/.github/workflows/lint.yml

Fixes https://github.com/onbjerg/foundry-toolchain/issues/3

Adds support for using a specific nightly release to run CI on, e.g. https://github.com/gakonst/foundry/releases/tag/nightly-6547691c6123c1bdbed770fcd245f1e63092befe.

Currently this action will assume that releases are a thing, which they are not currently. It also assumes things about the structure of release artifacts.

It would be nice if we could also support

• Installing nightly versions (perhaps we just release nightly versions upstream?)
• Installing specific commits, although this requires that we also build the toolchain every time

Possible inspirations: https://github.com/actions-rs/toolchain and https://github.com/actions-rs/core

It'd be really cool to be able to specify a specific nightly release to run CI on, e.g. https://github.com/gakonst/foundry/releases/tag/nightly-6547691c6123c1bdbed770fcd245f1e63092befe. It has a binary path unreachable using the current foundry-toolchain logic.

Maybe if the version is detected to follow the nightly-[0-9a-f]{40} format, replace it with plain nightly when generating the filename?

See the discussion here.

The idea would be to save and restore all the data in your ~/.foundry/cache/rpc/<chain name>/<block number> paths by default, so that users don't end up incurring additional RPC calls.

Support development builds

Foundry would have to add an additional identifier in its versioning to distinguish between nightly proper and dev/pr builds like

0.2.0-pr-47126-18

Also it would only work on branches in the main repo, not PR's (I think)

Something along the lines of this:

import * as core from '@actions/core'
import * as tc from '@actions/tool-cache'

async function run(): Promise<void> {
  try {
    const toolDir = tc.find('platform-', 'nightly-', 'x64')
    if (toolDir !== '') {
      core.addPath(toolDir)
      return
    }

    const channel = core.getInput('channel')

    // TODO: use feature/branch, github PR# for channels 
    if (!['nightly', 'edge', 'pr#', 'beta', ''].includes(channel)) {
      core.setFailed(`Unknown release channel ${channel}`)
      return
    }


      switch (process.platform) {
      case 'darwin': {
        let toolUrl =
          'https://nightly--darwin-amd64.zip'
        if (channel === 'beta') {
          toolUrl =
            'https://edge-darwin-amd64.zip'
        }
        const downloadPath = await tc.downloadTool(toolUrl)
        const extPath = await tc.extractZip(downloadPath)
        const cachedPath = await tc.cacheDir(extPath, 'release-', 'nightly-')
        core.addPath(cachedPath)
        break
      }

      case 'linux': {
        let toolUrl =
          'https://nightly-linux-amd64.tar.gz'
        if (channel === 'beta') {
          toolUrl =
            'https://edge-linux-amd64.tar.gz'
        }
        const downloadPath = await tc.downloadTool(toolUrl)
        const extPath = await tc.extractTar(downloadPath)
        const cachedPath = await tc.cacheDir(extPath, 'release-', 'nightly-')
        core.addPath(cachedPath)
        break
      }

      default: {
        core.setFailed(`Unsupported platform: ${process.platform}`)
      }
    }
  } catch (error) {
    core.setFailed(error.message)
  }
}

run()