From 74ab16895b79e3f82185613008b3d6ad59702dc3 Mon Sep 17 00:00:00 2001 From: Cameron Carstens Date: Fri, 30 Aug 2024 20:23:25 +0800 Subject: [PATCH] Prepare for v0.24.0 release (#291) ## Type of change - Release ## Changes The following changes have been made: - Prepares master for the v0.24.0 release ## Checklist - [x] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [x] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [x] I have added tests that prove my fix is effective or that my feature works. - [x] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers. - [x] I have updated the changelog to reflect the changes on this PR. --- CHANGELOG.md | 38 ++++++++++++++++++++------ Cargo.toml | 2 +- README.md | 2 +- docs/book/src/getting_started/index.md | 4 +-- 4 files changed, 33 insertions(+), 13 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 39694223..10be1f07 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,12 +7,36 @@ and this project adheres to [Semantic Versioning](http://semver.org/). ## [Unreleased] +Description of the upcoming release here. + ### Added +- Something new here 1 +- Something new here 2 + +### Changed + +- Something changed here 1 +- Something changed here 2 + +### Fixed + +- Some fix here 1 +- Some fix here 2 + +#### Breaking + +- Some breaking change here 1 +- Some breaking change here 2 + +## [Version 0.24.0] + +### Added v0.24.0 + - [#285](https://github.com/FuelLabs/sway-libs/pull/285) Adds the `BytecodeRoot` and `ContractConfigurables` types to the Bytecode Library. - [#286](https://github.com/FuelLabs/sway-libs/pull/286) Adds the `_metadata()` function to the Asset Library. -### Changed +### Changed v0.24.0 - [#286](https://github.com/FuelLabs/sway-libs/pull/286) Updates the repository to Sway-Standards v0.6.0 and implements the new SRC-20 and SRC-7 logging specifications. - [#286](https://github.com/FuelLabs/sway-libs/pull/286) `_set_metadata()`, `_set_name()` and `_set_symbol()` now revert if the metadata is an empty string. @@ -20,13 +44,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/). - [#286](https://github.com/FuelLabs/sway-libs/pull/286) `_mint()` and `_burn()` now revert if the `amount` argument is zero. - [#289](https://github.com/FuelLabs/sway-libs/pull/289) Bumps Sway-Libs to forc `v0.63.3`, fuel-core `v0.34.0`, and fuels `v0.66.2`. - [#290](https://github.com/FuelLabs/sway-libs/pull/290) Update the Upgradeability library to use a specific storage slot for owner functionality. +- [#291](https://github.com/FuelLabs/sway-libs/pull/291) Prepares for the `v0.24.0` release. -### Fixed - -- Some fix here 1 -- Some fix here 2 - -### Breaking +### Breaking v0.24.0 - [#285](https://github.com/FuelLabs/sway-libs/pull/285) Removes `_with_configurables()` functions from Bytecode Library in favor of using an `Option`. @@ -167,7 +187,7 @@ fn foo() { } ``` -## [v0.23.1] +## [Version 0.23.1] ### Added v0.23.1 @@ -186,7 +206,7 @@ fn foo() { - None -## [v0.23.0] +## [Version 0.23.0] ### Added v0.23.0 diff --git a/Cargo.toml b/Cargo.toml index 63e5bc11..65004cf8 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,4 +1,4 @@ [package] name = "sway-libs" -version = "0.23.1" +version = "0.24.0" edition = "2021" diff --git a/README.md b/README.md index c114edf7..00c0285f 100644 --- a/README.md +++ b/README.md @@ -75,7 +75,7 @@ For implementation details on the libraries please see the [Sway Libs Docs](http To import a library, the following dependency should be added to the project's `Forc.toml` file under `[dependencies]`. ```rust -sway_libs = { git = "https://github.com/FuelLabs/sway-libs", tag = "v0.23.1" } +sway_libs = { git = "https://github.com/FuelLabs/sway-libs", tag = "v0.24.0" } ``` > **NOTE:** diff --git a/docs/book/src/getting_started/index.md b/docs/book/src/getting_started/index.md index 7746e199..e57c5e38 100644 --- a/docs/book/src/getting_started/index.md +++ b/docs/book/src/getting_started/index.md @@ -5,7 +5,7 @@ To import any library, the following dependency should be added to the project's `Forc.toml` file under `[dependencies]`. ```sway -sway_libs = { git = "https://github.com/FuelLabs/sway-libs", tag = "v0.23.1" } +sway_libs = { git = "https://github.com/FuelLabs/sway-libs", tag = "v0.24.0" } ``` For reference, here is a complete `Forc.toml` file: @@ -18,7 +18,7 @@ license = "Apache-2.0" name = "MyProject" [dependencies] -sway_libs = { git = "https://github.com/FuelLabs/sway-libs", tag = "v0.23.1" } +sway_libs = { git = "https://github.com/FuelLabs/sway-libs", tag = "v0.24.0" } ``` > **NOTE:** Be sure to set the tag to the latest release.