Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
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
22 changes: 12 additions & 10 deletions src/ci-cd/github-actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

### Example workflow

```
```yml
on: [push]

name: test
Expand All @@ -14,7 +14,7 @@ jobs:
name: Foundry project
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
with:
submodules: recursive

Expand All @@ -30,12 +30,14 @@ jobs:

### Inputs

| Name | Required | Default | Description | Type |
|---|---|---|---|---|
| cache | No | true | Whether to cache RPC responses or not. | bool |
| version | No | nightly | Version to install, e.g. nightly or 1.8.8. Note: Foundry only has nightly builds for the time being. | string |
| cache-key | No | `${{ github.job }}` | The cache key to use for caching. | string |
| cache-restore-keys | No | `[${{ github.job }}]` | The cache keys to use for restoring the cache. | string[] |
### Inputs

| **Name** | **Required** | **Default** | **Description** | **Type** |
| -------------------- | ------------ | ------------------------------------- | -------------------------------------------------------- | -------- |
| `cache` | No | `true` | Whether to cache RPC responses or not. | bool |
| `version` | No | `stable` | Version to install, e.g. `stable`, `nightly` or `0.3.0`. | string |
| `cache-key` | No | `${{ github.job }}-${{ github.sha }}` | The cache key to use for caching. | string |
| `cache-restore-keys` | No | `[${{ github.job }}-]` | The cache keys to use for restoring the cache. | string[] |

### RPC Caching

Expand All @@ -49,7 +51,7 @@ The logic of the caching is as follows:

If you would like to disable the caching (e.g. because you want to implement your own caching mechanism), you can set the `cache` input to `false`, like this:

```
```yml
- name: Install Foundry
uses: foundry-rs/foundry-toolchain@v1
with:
Expand All @@ -62,7 +64,7 @@ You have the ability to define custom cache keys by utilizing the `cache-key` an

For instance, if you wish to utilize a shared cache between two distinct jobs, the following configuration can be applied:

```
```yml
- name: Install Foundry
uses: foundry-rs/foundry-toolchain@v1
with:
Expand Down
4 changes: 2 additions & 2 deletions src/config/continuous-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ jobs:
name: Foundry project
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
with:
submodules: recursive

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

- name: Run tests
run: forge test -vvv
Expand Down
2 changes: 1 addition & 1 deletion src/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ curl -L https://foundry.paradigm.xyz | bash

This will install Foundryup. Simply follow the on-screen instructions, and the `foundryup` command will become available in your CLI.

Running `foundryup` will automatically install the latest (nightly) versions of the [precompiled binaries](#precompiled-binaries): `forge`, `cast`, `anvil`, and `chisel`. For additional options, such as installing a specific version or commit, run `foundryup --help`.
Running `foundryup` will automatically install the latest stable version of the [precompiled binaries](#precompiled-binaries): `forge`, `cast`, `anvil`, and `chisel`. If you wish to use the latest `nightly` build run `foundryup --install nightly`. For additional options, such as installing a specific version or commit, run `foundryup --help`.

> ℹ️ **Note**
> If you're using Windows, you'll need to install and use [Git BASH](https://gitforwindows.org/) or [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) as your terminal, since Foundryup currently doesn't support Powershell or Command Prompt (Cmd).
Expand Down