chore: display warning to user if running `nightly` version #9683

zerosnacks · 2025-01-15T12:06:47Z

Motivation

Closes: #9676 + Closes #2212 (exposes SEMVER_VERSION) + Closes #5722

Three new version strings are exposed:

Short (-V)
Long (--version)
Semver (used for cheats, specific matching)

Short / long use the format as used by rustc / reth / solar

Updates: #8530 to use the new Foundry version format

On nightly builds - yields the warning:

pub const NIGHTLY_VERSION_WARNING_MESSAGE: &str =
    "This is a nightly build of Foundry. It is recommended to use the latest stable version. \
    Visit https://book.getfoundry.sh/announcements for more information. \n\
    To mute this warning set `FOUNDRY_DISABLE_NIGHTLY_WARNING` in your environment. \n";

If --silent or --json is passed the warning is muted

Solution

Creates a unified build script logic for the different binaries

Raises the warning right after global initialization of the shell as this is common logic for all binaries

Offers a user a way to mute the warning by setting FOUNDRY_DISABLE_NIGHTLY_WARNING in their shell

To test the nightly case:

PROFILE=release TAG_NAME=nightly make build

it will use the -nightly suffix:

forge Version: 0.3.1-nightly
Commit SHA: d6724dd503bedd961acc51102c4bcfb5159930d5
Build Timestamp: 2025-01-21T08:51:03.116597913Z (1737449463)
Build Profile: release

forge 0.3.1-nightly (d6724dd503 2025-01-21T08:51:03.116597913Z)

which raises

Warning: This is a nightly build of Foundry. It is recommended to use the latest stable version. Visit https://book.getfoundry.sh/announcements for more information. 
To mute this warning set `FOUNDRY_DISABLE_NIGHTLY_WARNING` in your environment. 
...

To test any other case (e.g. stable):

PROFILE=release TAG_NAME=stable make build

it will use the -stable suffix:

forge Version: 0.3.1-stable
Commit SHA: d6724dd503bedd961acc51102c4bcfb5159930d5
Build Timestamp: 2025-01-21T08:55:40.668257676Z (1737449740)
Build Profile: release

forge 0.3.1-stable (d6724dd503 2025-01-21T08:55:40.668257676Z)

Notice if you do not have a tag name set:

make build

it will use the -dev version suffix:

forge Version: 0.3.1-dev
Commit SHA: d6724dd503bedd961acc51102c4bcfb5159930d5
Build Timestamp: 2025-01-21T08:50:33.487130844Z (1737449433)
Build Profile: debug

forge 0.3.1-dev (d6724dd503 2025-01-21T08:50:33.487130844Z)

Note: I can't think of a good way to test this fully without actually creating a nightly build

Breaking changes

vm.getFoundryVersion will now use the format forge 0.3.0-dev+b3d0002118.1737037945.debug:

    /// Format: <cargo_version>-<tag>+<git_sha_short>.<unix_build_timestamp>.<profile>
    /// Sample output: 0.3.0-nightly+3cb96bde9b.1737036656.debug
    /// Note: Build timestamps may vary slightly across platforms due to separate CI jobs.
    /// For reliable version comparisons, use UNIX format (e.g., >= 1700000000)
    /// to compare timestamps while ignoring minor time differences.

as opposed to

    /// Format: <cargo_version>+<git_sha>+<build_timestamp>
    /// Sample output: 0.2.0+faa94c384+202407110019
    /// Note: Build timestamps may vary slightly across platforms due to separate CI jobs.
    /// For reliable version comparisons, use YYYYMMDD0000 format (e.g., >= 202407110000)
    /// to compare timestamps while ignoring minor time differences.

…E_NIGHTLY_WARNING environment variable

grandizzy · 2025-01-15T15:50:00Z

@zerosnacks wonder if this addresses #5722 too which basically requires a -debug label?

yash-atreya

lgtm!

zerosnacks · 2025-01-15T16:25:11Z

@zerosnacks wonder if this addresses #5722 too which basically requires a -debug label?

Good call, adding this - will postfix the profile as follows: 0.3.0-dev+ba03de0019.debug

zerosnacks · 2025-01-15T17:02:10Z

@zerosnacks wonder if this addresses #5722 too which basically requires a -debug label?

Added in 92ba0d9

crates/cli/build.rs

crates/common/src/version.rs

…yVersion() cheatcode

…n foundry_common and export from there

crates/anvil/src/config.rs

crates/cheatcodes/Cargo.toml

crates/cli/Cargo.toml

crates/common/Cargo.toml

crates/common/src/version.rs

testdata/default/cheats/GetFoundryVersion.t.sol

crates/common/src/version.rs

…nix timestamp for cheatcode, fix nits

…n readable --version

crates/common/src/version.rs

crates/cheatcodes/src/test.rs

DaniPopes · 2025-01-16T19:01:14Z

testdata/default/cheats/GetFoundryVersion.t.sol

@@ -8,19 +8,38 @@ contract GetFoundryVersionTest is DSTest {
    Vm constant vm = Vm(HEVM_ADDRESS);

    function testGetFoundryVersion() public view {
+        // (e.g. 0.3.0-nightly+3cb96bde9b.1737036656.debug)


if we're going to commit to a format that users want to parse themselves, maybe we should provide a function that does the comparison directly? Like vm.versionAtLeast("1.2.3") and/or vm.versionTimestampAtLeast(unix); I would prefer just the former for 1.0

Agreed, can be done in a follow up imo

crates/common/src/version.rs

Feedback addressed

zerosnacks · 2025-01-21T09:29:07Z

Updated description, performed additional manual tests and opened #9725 as a followup

Going to merge this so it is available in the next nightly

zerosnacks added 9 commits January 13, 2025 17:52

use shared compile time version builder

e4fb6ec

Merge branch 'master' into zerosnacks/add-type-to-version

a3e091e

add warning message on nightly builds

66e5466

display warning on nightly builds

ba03de0

derive nightly build from tag name

cdf0191

no need to pass IS_NIGHTLY in, derive from tag name

ed6b043

update warning message

6de826f

fix rustfmt

9005f86

fix clippy

459502b

zerosnacks self-assigned this Jan 15, 2025

zerosnacks added 3 commits January 15, 2025 15:32

clean up, default to always use -dev if not on tag

d980cc1

provide way for users to mute the warning by setting a FOUNDRY_DISABL…

3811996

…E_NIGHTLY_WARNING environment variable

fix fmt

786521d

zerosnacks marked this pull request as ready for review January 15, 2025 15:33

zerosnacks requested review from DaniPopes, klkvr, mattsse, grandizzy and yash-atreya as code owners January 15, 2025 15:33

yash-atreya previously approved these changes Jan 15, 2025

View reviewed changes

zerosnacks added 3 commits January 15, 2025 17:36

add profile to version

92ba0d9

fix clippy

d88ea34

fix fmt

15e9776

remove redundant build_timestamp as it is unused

3a95768

DaniPopes requested changes Jan 15, 2025

View reviewed changes

crates/cli/build.rs Outdated Show resolved Hide resolved

crates/common/src/version.rs Outdated Show resolved Hide resolved

crates/common/src/version.rs Outdated Show resolved Hide resolved

crates/common/src/version.rs Outdated Show resolved Hide resolved

zerosnacks added 2 commits January 16, 2025 11:18

unify build scripts, update cheatcodes build script, fix vm.getFoundr…

3258729

…yVersion() cheatcode

fix clippy

508e5c4

zerosnacks added 2 commits January 16, 2025 12:58

build timestamp not needed anymore, move to use single build script i…

f57b23e

…n foundry_common and export from there

clean up

3cb96bd

DaniPopes requested changes Jan 16, 2025

View reviewed changes

add timestamp due to users / documentation relying on it

5186142

This comment was marked as outdated.

Sign in to view

zerosnacks added 8 commits January 16, 2025 15:16

use verbose message format for cli --version, use SemVer compatible u…

cce2de7

…nix timestamp for cheatcode, fix nits

make IS_NIGHTLY_VERSION conditional

d22d757

use semver for cheatcode

b3d0002

fix test

4fb0b1d

fix value

62fe811

forge fmt

60234ac

nits, update getFoundryVersion cheatcode docs

8570642

fix incorrect version passed to forge cli, add unix timestamp to huma…

6de2207

…n readable --version

zerosnacks mentioned this pull request Jan 16, 2025

feat(cheatcodes): add vm.getFoundryVersion() #8036

Closed

zerosnacks requested a review from DaniPopes January 16, 2025 15:21

DaniPopes previously requested changes Jan 16, 2025

View reviewed changes

zerosnacks added 6 commits January 17, 2025 11:41

add tests, add short version / long version, address feedback

4307a4c

prefer build_timestamp for short version too

2cfb84c

fixes, add anvil tests for parsing

c8defa2

add back unix timestamp in full version

920170b

fix semver test

702d437

merge in master

00c2061

zerosnacks requested a review from DaniPopes January 20, 2025 11:52

Merge branch 'master' into zerosnacks/add-type-to-version

d6724dd

zerosnacks mentioned this pull request Jan 21, 2025

feat(cheatcodes): add vm.foundryVersionAtLeast + vm.foundryVersionCmp to make it easier to write conditional version logic #9725

Open

zerosnacks merged commit 62147c8 into master Jan 21, 2025
22 checks passed

zerosnacks deleted the zerosnacks/add-type-to-version branch January 21, 2025 09:29

zerosnacks mentioned this pull request Jan 21, 2025

fix: release process #9728

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: display warning to user if running `nightly` version #9683

chore: display warning to user if running `nightly` version #9683

zerosnacks commented Jan 15, 2025 •

edited

Loading

grandizzy commented Jan 15, 2025 •

edited

Loading

yash-atreya left a comment

zerosnacks commented Jan 15, 2025

zerosnacks commented Jan 15, 2025

This comment was marked as outdated.

DaniPopes Jan 16, 2025 •

edited

Loading

zerosnacks Jan 17, 2025

zerosnacks commented Jan 21, 2025

chore: display warning to user if running nightly version #9683

chore: display warning to user if running nightly version #9683

Conversation

zerosnacks commented Jan 15, 2025 • edited Loading

Motivation

Solution

Breaking changes

grandizzy commented Jan 15, 2025 • edited Loading

yash-atreya left a comment

Choose a reason for hiding this comment

zerosnacks commented Jan 15, 2025

zerosnacks commented Jan 15, 2025

This comment was marked as outdated.

DaniPopes Jan 16, 2025 • edited Loading

Choose a reason for hiding this comment

zerosnacks Jan 17, 2025

Choose a reason for hiding this comment

zerosnacks commented Jan 21, 2025

chore: display warning to user if running `nightly` version #9683

chore: display warning to user if running `nightly` version #9683

zerosnacks commented Jan 15, 2025 •

edited

Loading

grandizzy commented Jan 15, 2025 •

edited

Loading

DaniPopes Jan 16, 2025 •

edited

Loading