Skip to content

Commit

Permalink
Prepare cairo-lang-macro for publishing (#1495)
Browse files Browse the repository at this point in the history
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.*
  • Loading branch information
maciektr authored Jul 31, 2024
1 parent e47da64 commit b179da5
Show file tree
Hide file tree
Showing 6 changed files with 55 additions and 10 deletions.
25 changes: 21 additions & 4 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 16 additions & 0 deletions MAINTAINING.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,22 @@ Releasing `scarb-ui` crate is also a semi-automated process.
5. Push it.
6. Run `cargo publish -p scarb-ui`.

## `cairo-lang-macro` release procedure

Releasing `cairo-lang-macro` crate is also a semi-automated process.

1. Make sure correct version is present in:
1. `plugins/cairo-lang-macro/Cargo.toml`
2. `Cargo.lock`
You will probably have to commit changes and then tag newly created commit.
2. Make sure all changes to crates `cairo-lang-macro-attributes`, `cairo-lang-macro-stable`, `scarb-stable-hasher` are
released to crates.io as well.
3. Make sure you create it on a green commit (CI is passing), this is not verified!
4. Run `cargo publish -p cairo-lang-macro --dry-run` to verify that everything is fine.
5. Create a tag on `main` named `cairo-lang-macro/vX.Y.Z`.
6. Push it.
7. Run `cargo publish -p cairo-lang-macro`.

[@software-mansion/scarb-maintainers]: https://github.com/orgs/software-mansion/teams/scarb-maintainers

[@maciektr]: https://github.com/maciektr
Expand Down
9 changes: 9 additions & 0 deletions plugins/cairo-lang-macro/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Changelog

All notable changes to this project will be documented in this file.

## Unreleased

## 0.1.0 (2024-07-31)

- Initial release.
6 changes: 3 additions & 3 deletions plugins/cairo-lang-macro/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "cairo-lang-macro"
version = "0.0.1"
version = "0.1.0"
edition.workspace = true

authors.workspace = true
Expand All @@ -13,8 +13,8 @@ readme = "README.md"
repository.workspace = true

[dependencies]
cairo-lang-macro-attributes = { path = "../cairo-lang-macro-attributes" }
cairo-lang-macro-stable = { path = "../cairo-lang-macro-stable" }
cairo-lang-macro-attributes = "0.1"
cairo-lang-macro-stable = "1"
linkme.workspace = true

[dev-dependencies]
Expand Down
7 changes: 5 additions & 2 deletions plugins/cairo-lang-macro/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# cairo-lang-macro
# Cairo Lang Macro

Shared interface for Scarb procedural macros.
This crate exposes an API for writing Scarb procedural macros for Cairo language.
To learn more about Scarb procedural macros, please see the [Scarb documentation].

[Scarb documentation]: https://docs.swmansion.com/scarb/
2 changes: 1 addition & 1 deletion scarb/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ cairo-lang-filesystem.workspace = true
cairo-lang-formatter.workspace = true
cairo-lang-lowering.workspace = true
cairo-lang-macro = { path = "../plugins/cairo-lang-macro" }
cairo-lang-macro-stable = { path = "../plugins/cairo-lang-macro-stable" }
cairo-lang-macro-stable = "1"
cairo-lang-parser.workspace = true
cairo-lang-semantic.workspace = true
cairo-lang-sierra-to-casm.workspace = true
Expand Down

0 comments on commit b179da5

Please sign in to comment.