Skip to content

Commit b179da5

Browse files
authored
Prepare cairo-lang-macro for publishing (#1495)
commit-id:874f8bab --- **Stack**: - #1497 - #1496 - #1495⚠️ *Part of a stack created by [spr](https://github.com/ejoffe/spr). Do not merge manually using the UI - doing so may have unexpected results.*
1 parent e47da64 commit b179da5

File tree

6 files changed

+55
-10
lines changed

6 files changed

+55
-10
lines changed

Cargo.lock

+21-4
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

MAINTAINING.md

+16
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,22 @@ Releasing `scarb-ui` crate is also a semi-automated process.
167167
5. Push it.
168168
6. Run `cargo publish -p scarb-ui`.
169169

170+
## `cairo-lang-macro` release procedure
171+
172+
Releasing `cairo-lang-macro` crate is also a semi-automated process.
173+
174+
1. Make sure correct version is present in:
175+
1. `plugins/cairo-lang-macro/Cargo.toml`
176+
2. `Cargo.lock`
177+
You will probably have to commit changes and then tag newly created commit.
178+
2. Make sure all changes to crates `cairo-lang-macro-attributes`, `cairo-lang-macro-stable`, `scarb-stable-hasher` are
179+
released to crates.io as well.
180+
3. Make sure you create it on a green commit (CI is passing), this is not verified!
181+
4. Run `cargo publish -p cairo-lang-macro --dry-run` to verify that everything is fine.
182+
5. Create a tag on `main` named `cairo-lang-macro/vX.Y.Z`.
183+
6. Push it.
184+
7. Run `cargo publish -p cairo-lang-macro`.
185+
170186
[@software-mansion/scarb-maintainers]: https://github.com/orgs/software-mansion/teams/scarb-maintainers
171187

172188
[@maciektr]: https://github.com/maciektr

plugins/cairo-lang-macro/CHANGELOG.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
## Unreleased
6+
7+
## 0.1.0 (2024-07-31)
8+
9+
- Initial release.

plugins/cairo-lang-macro/Cargo.toml

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "cairo-lang-macro"
3-
version = "0.0.1"
3+
version = "0.1.0"
44
edition.workspace = true
55

66
authors.workspace = true
@@ -13,8 +13,8 @@ readme = "README.md"
1313
repository.workspace = true
1414

1515
[dependencies]
16-
cairo-lang-macro-attributes = { path = "../cairo-lang-macro-attributes" }
17-
cairo-lang-macro-stable = { path = "../cairo-lang-macro-stable" }
16+
cairo-lang-macro-attributes = "0.1"
17+
cairo-lang-macro-stable = "1"
1818
linkme.workspace = true
1919

2020
[dev-dependencies]

plugins/cairo-lang-macro/README.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1-
# cairo-lang-macro
1+
# Cairo Lang Macro
22

3-
Shared interface for Scarb procedural macros.
3+
This crate exposes an API for writing Scarb procedural macros for Cairo language.
4+
To learn more about Scarb procedural macros, please see the [Scarb documentation].
5+
6+
[Scarb documentation]: https://docs.swmansion.com/scarb/

scarb/Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ cairo-lang-filesystem.workspace = true
2323
cairo-lang-formatter.workspace = true
2424
cairo-lang-lowering.workspace = true
2525
cairo-lang-macro = { path = "../plugins/cairo-lang-macro" }
26-
cairo-lang-macro-stable = { path = "../plugins/cairo-lang-macro-stable" }
26+
cairo-lang-macro-stable = "1"
2727
cairo-lang-parser.workspace = true
2828
cairo-lang-semantic.workspace = true
2929
cairo-lang-sierra-to-casm.workspace = true

0 commit comments

Comments
 (0)