Skip to content

Latest commit

 

History

History
200 lines (138 loc) · 7.35 KB

MAINTAINING.md

File metadata and controls

200 lines (138 loc) · 7.35 KB
Raw

Scarb Maintenance

Maintainers

All Scarb maintainers are members of the @software-mansion/scarb-maintainers GitHub team. Current project leader is @maciektr.

Release procedure

Releasing Scarb is a semi-automated process. It usually takes a couple of hours for me (~Marek), depending on if there are some last-minute patches to be made. The longest part is writing release notes.

Cut new version

In a nutshell, this is trivial: create a tag on main named vX.Y.Z. There is a tag protection rule set up! Make sure you create it on a green commit (CI is passing), this is not verified! A tag should trigger a Release workflow which builds binaries, verifies them and drafts a GitHub release. It usually takes about half an hour.

Create release branch

Sometimes main could be ahead with some commits that you might not want to include in this release. It's totally fine to start a release branch in such scenarios. The branch must be named release/X.Y, there's branch protection rule set up for this. Then, cherry-pick commits that you might want to include. After all is done, push the branch and a vX.Y.Z tag as usual!

As for website, don't forget to ensure that it should match latest Scarb version, i.e. almost always be published from tags on main. Release branches are allowed to be sources for website deployments, and so they will deploy from tags in release branches. You might need to swiftly pause the Website Deploy workflow to prevent publishing old website version.

Important

Make sure scarb-metadata crate is released and published to crates.io. Only StarkNet Crates.io Admins can do this.

Important

If you add or remove a binary target compiled with the release (i.e. create or remove a crate in extensions directory), make sure to work with the Homebrew team to upgrade their Scarb installation formula.

Write release notes

Upon completion, the Release workflow should draft a release on GitHub. Now comes the most tedious and time-consuming part that nobody likes: writing release notes! We take an inspiration from the awesome release notes that Visual Studio Code does.

  1. Open the draft release.
  2. Click Generate release notes, we will use this information in next step.
  3. Leave release title intact.
  4. If this is applicable, ✅ Set as a pre-release.
  5. If this is applicable, ✅ Set as the latest release.
  6. Use the template.
  7. Don't forget to Save draft frequently!

Template

[Cairo release notes ➡️](https://github.com/starkware-libs/cairo/releases/tag/vX.Y.Z)

Welcome to the release notes for Scarb vX.Y.Z!
This release is all about blahblah

* **Blah blah** - Why this blah is so much blah.
* **Even more blah blah** - Everything is awesome.
    * **Sometimes some sub-blah is cool** - Yeah.

## Highlight Point Title

Elaborate what this is about, what has changed, etc.
Be as descriptive as you can.

## Cairo Version

This version of Scarb comes with Cairo [`vX.Y.Z`](https://github.com/starkware-libs/cairo/releases/tag/vX.Y.Z).

## What's Changed

<!-- Here goes output from `Generate release notes` button. -->

**Full Changelog**: https://github.com/software-mansion/scarb/compare/...

Important

The Cairo version section is very important. Scarb website is parsing this sentence (the link to release notes, to be precise) to infer what version of Cairo is used in this release.

Announce release on social media

Twitter

Post an announcement Tweet from your personal account, people tend to favour interacting with real humans accounts, rather than corporate ones.

Here is example template, it's recommended to slightly change the copy, so that it won't look like robotic action:

Happy to announce that Scarb vX.Y.Z is live!

🔥 blahblah
🚀 even more blahblah

Go check it out: https://docs.swmansion.com/scarb/download.html
Release notes: https://github.com/software-mansion/scarb/releases/tag/vX.Y.Z

@swmansionxyz @StarkWareLtd

Important: The mentions are super important! They seem to help generate more traffic. Also post tweet link to #crypto-mansion-marketing and #starkware-swm Slack channels, and do ensure that both Twitter accounts retweet your tweet on the same day.

Starknet Telegram

Post an announcement message on the private Starknet channel where everybody is on Telegram. All maintainers should be members of this group since their start.

Use similar text to one used in a Tweet, just attach Tweet link at the end, and do not mention anybody:

Announcing Scarb vX.Y.Z!

🔥 blahblah
🚀 even more blahblah

Download: https://docs.swmansion.com/scarb/download.html
Release notes: https://github.com/software-mansion/scarb/releases/tag/vX.Y.Z
Tweet: https://twitter.com/...

Starknet Discord

Post the same message as posted on the Telegram to the #scarb channel on Starknet's Discord.

scarb-metadata release procedure

Releasing scarb-metadata crate is also a semi-automated process.

  1. Make sure correct version is present in:

    1. scarb-metadata/Cargo.toml
    2. Cargo.lock

    You will probably have to commit changes and then tag newly created commit.

  2. Make sure you create it on a green commit (CI is passing), this is not verified!

  3. Run cargo publish -p scarb-metadata --dry-run to verify that everything is fine.

  4. Create a tag on main named scarb-metadata/vX.Y.Z.

  5. Push it.

  6. Run cargo publish -p scarb-metadata.

scarb-ui release procedure

Releasing scarb-ui crate is also a semi-automated process.

  1. Make sure correct version is present in:

    1. scarb-ui/Cargo.toml
    2. Cargo.lock

    You will probably have to commit changes and then tag newly created commit.

  2. Make sure you create it on a green commit (CI is passing), this is not verified!

  3. Run cargo publish -p scarb-ui --dry-run to verify that everything is fine.

  4. Create a tag on main named scarb-ui/vX.Y.Z.

  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.