Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Build binaries for publishing on GitHub #416

Merged
merged 56 commits into from
Apr 12, 2024
Merged

Build binaries for publishing on GitHub #416

merged 56 commits into from
Apr 12, 2024

Conversation

FabijanC
Copy link
Contributor

@FabijanC FabijanC commented Apr 9, 2024

Usage related changes

  • Closes Binaries can be published #269.
  • The plan for future releases is described in: Binaries can be published #269 (comment). The next release after this PR is merged should have the artifacts attached.
  • Improve README.md
    • More systematic installation instructions
    • Pythonic Devnet uninstallation notice
    • Replace cargo run -- with starknet-devnet
      • Rationale: those who know how to build from source will know how to run from source
  • README on crates.io is empty - this is fixed by relying on the workspace README

Development related changes

  • Remove dependency on runtime predeployed contract artifacts being at exact paths
    • Done by using include_str! macro which reads path at compile-time
    • fn cairo_1_from_path become unused so it's removed
  • Install vendored openssl, couldn't build otherwise - this also allows removing libssl-dev installation from Dockerfile
  • Every platform from the matrix [x86_64, aarch64] x [unknown-linux-gnu, unknown-linux-musl, apple-darwin] is supported in binary build
  • Dockerization could be improved by reusing the built binaries (worth opening an issue)
  • Built Docker image validation no longer relying on the REMOTE env var - checking /.dockerenv instead
  • Add docs about new version release
    • Add scripts/check_crate_changes.sh
  • Improve main workflow name
    • Often I would confuse the workflow name and the branch name on CircleCI since they can both be main.

Checklist:

  • Checked the relevant parts of development docs
  • Applied formatting - ./scripts/format.sh
  • No linter errors - ./scripts/clippy_check.sh
  • No unused dependencies - ./scripts/check_unused_deps.sh
  • Performed code self-review
  • Rebased to the latest commit of the target branch (or merged it into my branch)
  • Updated the docs if needed, including the TODO section
  • Linked the issues which this PR resolves
  • Updated the tests if needed; all passing (execution info)

@FabijanC FabijanC marked this pull request as draft April 10, 2024 10:15
@FabijanC FabijanC marked this pull request as ready for review April 11, 2024 13:07
@FabijanC FabijanC merged commit a5515a5 into main Apr 12, 2024
@FabijanC FabijanC deleted the github-binary branch April 12, 2024 10:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Binaries can be published
2 participants