Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
refactor: make "version" input not required
chore: use double quotes in "action.yml"
docs: add brief description about Foundry in README
docs: fix typos in README
docs: remove optional input "version" from example script
refactor: set "nightly" as default value for "version"
  • Loading branch information
PaulRBerg committed Jan 7, 2023
commit 23f9eb2a8fa98b68458194fd393840ed1c8ca592
13 changes: 5 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## `foundry-toolchain` Action

This GitHub Action installs [Foundry](https://github.com/foundry-rs/foundry).
This GitHub Action installs [Foundry](https://github.com/foundry-rs/foundry), the blazing fast, portable and modular toolkit for Ethereum application development.

### Example workflow

Expand All @@ -20,8 +20,6 @@ jobs:

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

- name: Run tests
run: forge test -vvv
Expand All @@ -32,10 +30,9 @@ jobs:

### Inputs

| **Name** | **Required** | **Description** | **Type** |
|-----------|--------------|---------------------------------------------------------------------------------------------------------------|----------|
| `version` | Yes | Version to install, e.g. `nightly` or `1.0.0`. **Note:** Foundry only has nightly builds for the time being. | string |

| **Name** | **Required** | **Default** | **Description** | **Type** |
| --------- | ------------ | ----------- | ------------------------------------------------------------------------------------------------------------ | -------- |
| `version` | No | `nightly` | Version to install, e.g. `nightly` or `1.0.0`. **Note:** Foundry only has nightly builds for the time being. | string |

### Summaries

Expand All @@ -48,4 +45,4 @@ For example, to add the output of `forge snapshot` to a summary, you would chang
run: NO_COLOR=1 forge snapshot >> $GITHUB_STEP_SUMMARY
```

See the offical [GitHub docs](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary) for more information.
See the official [GitHub docs](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary) for more information.
17 changes: 10 additions & 7 deletions action.yml
Original file line number Diff line number Diff line change
@@ -1,17 +1,20 @@
name: 'foundry-toolchain'
description: 'Install Foundry'
author: 'Oliver Nordbjerg'
name: "foundry-toolchain"
description: "Install Foundry"
author: "Oliver Nordbjerg"
branding:
icon: play-circle
color: gray-dark
color: "gray-dark"
icon: "play-circle"

inputs:
version:
default: "nightly"
description: |
Foundry version.

This version number has to match a released version of Foundry.
Alternatively you can also specify `nightly` for the latest nightly build.
required: false

runs:
using: node16
main: dist/index.js
using: "node16"
main: "dist/index.js"