v0.6.2

Scarb 0.6.2

Welcome to the release notes for Scarb v0.6.2!
This quick release is primarily Cairo upgrade to v2.1.1.

Cairo Version

This version of Scarb comes with Cairo v2.1.1.

What's Changed

Full Changelog: v0.6.1...v0.6.2

v0.6.1

Scarb 0.6.1

Welcome to the release notes for Scarb v0.6.1! This release brings several small quality-of-life improvements:

• scarb cairo-run will automatically call scarb build code before running
• new command: scarb cache clean wipes Scarb global cache directory
• scarb-metadata v.1.6.0 adds ScarbCommand helper for quick shelling into core scarb CLI

Cairo version

This version of Scarb comes with Cairo v2.1.0.

What's Changed

• Rewrite website with Vitepress by @mkaput in #501
• Last-minute website fixes by @mkaput in #541
• MAINTAINING.md: stop publishing scarb crate to crates.io by @mkaput in #540
• More website fixes by @mkaput in #542
• Another batch of website updates by @mkaput in #545
• Move Windows download instructions to "by os" section by @mkaput in #546
• Various error messages improvements by @mkaput in #549
• Upgrade Cairo to 84f933b by @mkaput in #552
• Add Scarb command abstraction, build Scarb project before run by @maciektr in #543
• Update Alexandria references to refer to new package structure by @mkaput in #555
• Add scarb cache clean subcommand by @MrDenkoV in #531
• Rename nightly artifacts to be accessible from bash scripts by @szymmis in #556
• Fix global directories casing in documentation by @mkaput in #557
• Update dependabot.yml by @mkaput in #559
• Make Website Deploy workflow always deploy from main when run on release event by @mkaput in #560
• Bump semver from 1.0.17 to 1.0.18 by @dependabot in #562
• Bump the non-critical group with 12 updates by @dependabot in #563

Full Changelog: v0.6.0...v0.6.1

v0.6.0

Scarb 0.6.0

Welcome to the release notes for Scarb v0.6.0! This release brings a new big feature: workspaces, and upgrades Cairo to freshly released stable 2.1.0 version!

Workspaces

Scarb now natively supports projects consisting of multiple packages. Such projects are called workspaces and a denoted by a Scarb.toml file in root directory which contains a new section: [workspace]:

# [PROJECT_DIR]/Scarb.toml
[workspace]
members = ["hello_world"]
# [PROJECT_DIR]/hello_world/Scarb.toml
[package]
name = "hello_world" # the name of the package
version = "0.1.0"    # the current version, obeying semver
authors = ["Alice <a@example.com>", "Bob <b@example.com>"]

Workspaces are properly handled when pulling dependencies, and all commands and extensions should become aware of them on day one if they use scarb-metadata v1.5.0.

This feature is almost 1:1 copy-paste of Cargo's Workspaces. Therefore, it should feel familiar to Rust coders. For more information, check out relevant piece of documentation.

scarb crate

Starting with this release, we publicly announce that the scarb crate on crates.io is deprecated and will not receive further updates (including this Scarb version). We also announce that we plan to deprecate the scarb crate altogether in the future, but for this to happen we need to bring feature-parity between this crate and Scarb binaries.

We advise our existing users to pull Scarb directly from Git repository, and new users to avoid using Scarb as Rust crate altogether and instead talk to user-installed scarb CLI via the scarb-metadata crate. Scarb documentation will be updated accordingly in coming days, as we're reworking it entirely right now.

The reason for this is that the scarb crate existence is blocking us from doing several improvements we would like to have in the future, such as isolating Cairo compilation in a separate OS process.

If you have any further questions, please reach to us on our Telegram or Discord channels. We'll be happy to respond :-)

Cairo version

This version of Scarb comes with Cairo v2.1.0.

What's Changed

• Publish nightlies to release repository by @mkaput in #527
• Fix paths issue on Windows by @mkaput in #529
• Filter hidden dirs found in member glob expansion by @maciektr in #508
• Workspace documentation by @maciektr in #532
• Upgrade Cairo to 2.1.0 by @mkaput in #534
• Revert "Run compiler in a new thread with increased stack size" by @mkaput in #535
• Upgrade various dependencies by @mkaput in #536
• Prepare release 0.6.0 by @mkaput in #537

Full Changelog: v0.6.0-alpha.4...v0.6.0
Changelog since Scarb v0.5.2: v0.5.2...v0.6.0

0.6.0-alpha.4

Welcome to the release notes for Scarb v0.6.0-alpha.4! This release bumps Cairo, adds scarb fetch command, fixes some bugs and brings internal changes paving the road for workspaces support.

scarb fetch

This small command is analogous to cargo fetch. Its job is simple: just pull dependencies of current project and do nothing else. In the future, this command will also update the lock file.

Big thank you to @GianfrancoBazzani for implementing this! 👏🏻

Git interdependencies bug fix

We have fixed a bug which prevented from using following dependency tree:

┌───┐   git    ┌───┐
│ X ├─────────►│ A │
└─┬─┘          └───┘
  │              ▲
  │              │ path = "../a"
  │              │
  │     git    ┌─┴─┐
  └───────────►│ B │
               └───┘

Workspaces support

We have started merging the PR stack, which implements workspaces. Not everything was merged, and thus we do not advise making use of these changes yet!

Cairo version

This version of Scarb comes with Cairo v2.1.0-rc4.

What's Changed

• Remove asdf plugin repo link from docs by @maciektr in #505
• Cairo-test: Warn when scarb version does not match by @maciektr in #503
• Converted Protostar references and updated docs links by @MrDenkoV in #507
• Publish the roadmap in readme and update architecture docs by @mkaput in #512
• Add workspace example by @maciektr in #446
• Bump clap from 4.3.10 to 4.3.19 by @dependabot in #521
• Bump camino from 1.1.4 to 1.1.6 by @dependabot in #520
• Bump async-trait from 0.1.68 to 0.1.72 by @dependabot in #519
• Bump thiserror from 1.0.40 to 1.0.44 by @dependabot in #517
• Bump actions/upload-pages-artifact from 1 to 2 by @dependabot in #522
• Format only selected packages by @maciektr in #490
• Make build tests not fail if they run too long by @mkaput in #523
• Patch path dependencies for git sources by @maciektr in #514
• Add runtime check for Core library and Cairo compiler versions by @MrDenkoV in #524
• Update Cairo to 2.1.0-rc4 by @maciektr in #528
• Add compile time check for Core library and Cairo compiler versions by @MrDenkoV in #513
• Add info about .tool-versions and caching to CI docs section by @szymmis in #511
• Adds scarb fetch by @GianfrancoBazzani in #509

New Contributors

• @MrDenkoV made their first contribution in #507
• @szymmis made their first contribution in #511
• @GianfrancoBazzani made their first contribution in #509

Full Changelog: v0.6.0-alpha.2...v0.6.0-alpha.4

0.6.0-alpha.2

Scarb 0.6.0-alpha.2

Welcome to the release notes for Scarb v0.6.0-alpha.2! This quick release is primarily Cairo upgrade to v2.1.0-rc2.

It includes some foundational work towards Scarb nightlies. 🌃

Cairo version

This version of Scarb comes with Cairo v2.1.0-rc2.

What's Changed

• Scarb nightlies by @mkaput in #483

Full Changelog: v0.6.0-alpha.1...v0.6.0-alpha.2

0.6.0-alpha.1

Scarb 0.6.0-alpha.1

Welcome to the release notes for Scarb 0.6.0-alpha.1! This release is primarily Cairo upgrade to v2.1.0-rc1. There are only small cosmetic changes to Scarb itself in this release, but we're heavily working on some big stuff 👀

Cairo version

This version of Scarb comes with Cairo v2.1.0-rc1.

What's Changed

• Add file is_hidden check by @maciektr in #444
• Fix misleading help message for --manifest-path argument by @mkaput in #488
• Fix commands listing table cells width by @maciektr in #492
• Upgrade Cairo to 2.1.0-rc1 by @mkaput in #498

Full Changelog: v0.6.0-alpha.0...v0.6.0-alpha.1

0.6.0-alpha.0

Scarb 0.6.0-alpha.0

Welcome to the release notes for the first Scarb 0.6.0 line release! As Cairo 2.1.0-rc0 has been released, we are doing next major version bump.

There are no user-visible changes to Scarb itself in this release, but we did a lot of improvements to documentation and to our internal workflows this cycle.

Cairo version

This version of Scarb comes with Cairo v2.1.0-rc0.

What's Changed

• Extract CommandExt to support module by @mkaput in #470
• Split tests into many binaries and move support module to a separate crate by @mkaput in #471
• Partition tests using nextest by @mkaput in #472
• Make CI workflow run on Linux only by @mkaput in #473
• Temporarily remove asdf plugin add scarb until it will work by @mkaput in #476
• Update CI docs page by @mkaput in #477
• Mention ASDF installation on the home page by @mkaput in #478
• Do not run Scarb CI on website-only changes by @mkaput in #479
• Ensure everything required is passing for branch protection by @mkaput in #480
• Partially revert recent CI changes and consolidate all CI workflows into one by @mkaput in #481
• Fix lints reported by Clippy 1.71 by @mkaput in #484
• Update guides to latest changes in ecosystem by @mkaput in #485
• Upgrade Cairo to 2.1.0-rc0 by @mkaput in #486

Full Changelog: v0.5.2...v0.6.0-alpha.0

0.5.2

Scarb 0.5.2

Welcome to the release notes for Scarb 0.5.2! This release upgrades Cairo to 2.0.2 and brings one small feature.

Compiling external contracts

While compiling the Scarb project, by default, no artefacts are emitted for contracts defined in dependencies. It is now possible to instruct scarb build to include external contracts in the compilation of your package. This can be for example useful in some custom testing flows as requested by several Scarb users. For example, if your package depends on hypothetical package utility_contracts which provides Account contract, you can tell Scarb to compile Hello as part of your build:

[dependencies]
starknet = "2.0.0"
utility_contracts = { path = "../shared_contracts" }
 
[[target.starknet-contract]]
build-external-contracts = ["utility_contracts::Account"]

See relevant documentation section for more information.

Cairo version

This version of Scarb comes with Cairo v2.0.2.

What's Changed

• Combine download & install pages and mention ASDF plugin by @mkaput in #462
• Build external contracts by @maciektr in #458
• Upgrade Cairo to 2.0.2 by @mkaput in #467

Full Changelog: v0.5.1...v0.5.2

0.5.1

Scarb 0.5.1

Welcome to the release notes for Scarb v0.5.1! This release upgrades Cairo to 2.0.1 and brings some bugfixes.

Compiled contracts and starknet_artifacts files rename

Given the following package manifest:

[package]
name = "PACKAGE"

[[target.starknet-contract]]
name = "TARGET"

Until this version, compiler contracts and the artefacts file followed the following naming scheme:

• TARGET_contract.json
• PACKAGE.starknet_contracts.json

This is incorrect, as when the package defined multiple starknet-contract targets, they will override each other outputs. Since this Scarb version, it will now follow this naming scheme:

• TARGET_contract.json
• TARGET.starknet_contracts.json

Technically, this is a breaking change. But, because of the following reasons, we decided not to cut a major release and treat this as a bugfix:

1. Unless explicitly set TARGET == PACKAGE, so the outcome does not change.
2. It should not be noticeable for humans when they look for files in file managers.
3. While to our knowledge, tools do not rely on these files names anyway and instead look for all *.starknet_contracts.json files in order to look for contract files.

Cairo version

This version of Scarb comes with Cairo v2.0.1.

What's Changed

• Document starknet_artifacts.json file by @cptartur in #454
• Use target_name instead of package_name for starknet_artifacts map file by @maciektr in #459
• Update Cairo to 2.0.1 by @mkaput in #461
• Resolver: add all dependencies to graph by @maciektr in #441

New Contributors

• @cptartur made their first contribution in #454

Full Changelog: v0.5.0...v0.5.1

0.5.0

Scarb 0.5.0

Welcome to the release notes for Scarb v0.5.0! This release brings stable Cairo 2.0 in preparation for Starknet 0.12 🎉 There are no other significant changes since last pre-release, solidifying stability of Scarb 0.5 release line.

Cairo version

This version of Scarb comes with Cairo v2.0.0.

What's Changed

• Fix typo in default profile in cheatsheet by @maciektr in #439
• Use packages filter in fmt by @maciektr in #440
• Bump clap from 4.3.2 to 4.3.10 by @dependabot in #452
• Bump libc from 0.2.146 to 0.2.147 by @dependabot in #449
• Bump log from 0.4.18 to 0.4.19 by @dependabot in #448
• Bump tokio from 1.28.2 to 1.29.1 by @dependabot in #450
• Upgrade Cairo to 2.0.0 by @mkaput in #453
• Bump toml from 0.7.4 to 0.7.5 by @dependabot in #451

Full Changelog: v0.5.0-alpha.4...v0.5.0
Changelog since Scarb 0.4: v0.4.0...v0.5.0