Skip to content

Commit

Permalink
add announcements page
Browse files Browse the repository at this point in the history
  • Loading branch information
zerosnacks committed Jan 14, 2025
1 parent 205747b commit c40aab7
Show file tree
Hide file tree
Showing 3 changed files with 104 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,18 @@ Foundry is a smart contract development toolchain.

Foundry manages your dependencies, compiles your project, runs tests, deploys, and lets you interact with the chain from the command-line and via Solidity scripts.

> **Announcements**
>
> [Catch up on the latest changes](./announcements.md) to Foundry.
> 📖 **Contributing**
>
> You can contribute to this book on [GitHub](https://github.com/foundry-rs/book).
### Sections

**[Annoucements](./announcements.md)**

**[Getting Started](getting-started/installation.md)**

To get started with Foundry, install Foundry and set up your first project.
Expand Down
1 change: 1 addition & 0 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@

# Appendix

- [Announcements](./announcements.md)
- [FAQ](./faq.md)
- [Help us improve Foundry](./contributing.md)
- [References](./reference/README.md)
Expand Down
97 changes: 97 additions & 0 deletions src/announcements.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
## Announcements

Stay up to date on the latest changes to Foundry.

## 🚨 Actions required

Upgrade your installation of Foundryup!

Run: `curl -L https://foundry.paradigm.xyz | bash`

Upgrading ensures your installation defaults to updating to the **latest stable release** instead of the **latest nightly build**.

If you do not upgrade you will **continue to receive nightly builds by default** which will start to contain more **significant breaking changes**.

## Releases

### 0.3 (stable)

The Foundry [`0.3` release](https://github.com/foundry-rs/foundry/releases/tag/v0.3.0) marks an exciting new chapter for Foundry. By moving to [stable releases](https://github.com/foundry-rs/foundry/releases/tag/stable), we aim to provide a reliable development environment for the EVM ecosystem. Our next priority is the `1.0` release in early 2025, polishing Foundry for the long term.

Big shoutout to the Foundry community - your bug reports, feature requests and contributions have shaped what Foundry is today.

## FAQ

#### How do I update `foundryup`?

Run: `curl -L https://foundry.paradigm.xyz | bash`

After updating you'll be able to update to the latest version of `foundryup` by running `foundryup --update`.

#### How do I install multiple versions?

Easily install different versions using:

```
foundryup --install <version>
```

e.g.

```
foundryup --install nightly
foundryup --install stable
foundryup --install 0.3.0
```

#### How do I know the versions I have installed?

Run

```
foundryup --list
```

This will output a list as follows:

```
foundryup: nightly
foundryup: - forge 0.3.0 (017c59d 2025-01-14T00:25:28.977200980Z)
foundryup: - cast 0.3.0 (017c59d 2025-01-14T00:25:28.933986754Z)
foundryup: - anvil 0.3.0 (017c59d 2025-01-14T00:25:29.065516554Z)
foundryup: - chisel 0.3.0 (017c59d 2025-01-14T00:25:29.021147876Z)
foundryup: stable
foundryup: - forge 0.3.0 (5a8bd89 2024-12-20T08:46:21.555250780Z)
foundryup: - cast 0.3.0 (5a8bd89 2024-12-20T08:46:21.564365462Z)
foundryup: - anvil 0.3.0 (5a8bd89 2024-12-20T08:46:21.565569027Z)
foundryup: - chisel 0.3.0 (5a8bd89 2024-12-20T08:46:21.536871477Z)
foundryup: v0.3.0
foundryup: - forge 0.3.0 (5a8bd89 2024-12-19T17:17:10.245193696Z)
foundryup: - cast 0.3.0 (5a8bd89 2024-12-19T17:17:10.252265834Z)
foundryup: - anvil 0.3.0 (5a8bd89 2024-12-19T17:17:10.248488022Z)
foundryup: - chisel 0.3.0 (5a8bd89 2024-12-19T17:17:10.201917651Z)
```

#### How do I switch between versions?

Easily manage your installations with:

```
foundryup --use <version>
```

e.g.

```
foundryup --use nightly
foundryup --use stable
foundryup --use 0.3.0
```

#### I prefer using nightly builds.

You are still able to receive the latest nightly builds by running `foundryup --install nightly`

**Be cautious — nightly builds may include breaking changes that are difficult to debug without context.**

0 comments on commit c40aab7

Please sign in to comment.