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

Customize cargo profiles #401

Merged
merged 8 commits into from Feb 23, 2022
Merged

Customize cargo profiles #401

merged 8 commits into from Feb 23, 2022

Conversation

Dengjianping
Copy link
Contributor

@Dengjianping Dengjianping commented Feb 15, 2022

Description

Rust 1.57 supports to customize cargo profile, so we can move rustc flags(like lto, code-unit) to customized profile.

Add a new profile production which inherits from release.
How to use this profile:

cargo b --profile production

closes: #295


Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Targeted PR against correct branch (manta or dolphin) with right title (start with [Manta] or [Dolphin]),
  • Linked to Github issue with discussion and accepted design OR have an explanation in the PR that describes this work.
  • Wrote unit tests.
  • Updated relevant documentation in the code.
  • Re-reviewed Files changed in the Github PR explorer.
  • If runtime changes, need to update the version numbers properly:
    • authoring_version: The version of the authorship interface. An authoring node will not attempt to author blocks unless this is equal to its native runtime.
    • spec_version: The version of the runtime specification. A full node will not attempt to use its native runtime in substitute for the on-chain Wasm runtime unless all of spec_name, spec_version, and authoring_version are the same between Wasm and native.
    • impl_version: The version of the implementation of the specification. Nodes are free to ignore this; it serves only as an indication that the code is different; as long as the other two versions are the same then while the actual code may be different, it is nonetheless required to do the same thing. Non-consensus-breaking optimizations are about the only changes that could be made which would result in only the impl_version changing.
    • transaction_version: The version of the extrinsics interface. This number must be updated in the following circumstances: extrinsic parameters (number, order, or types) have been changed; extrinsics or pallets have been removed; or the pallet order in the construct_runtime! macro or extrinsic order in a pallet has been changed. If this number is updated, then the spec_version must also be updated
  • If needed, notify the committer this is a draft-release and a tag is needed after merging the PR.
  • Verify benchmarks & weights have been updated for any modified runtime logics
  • If needed, bump version for every crate.
  • If import a new pallet, choose a proper module index for it, and allow it in BaseFilter. Ensure every extrinsic works from front-end. If there's corresponding tool, ensure both work for each other.
  • If needed, update our Javascript/Typescript APIs. These APIs are offcially used by exchanges or community developers.
  • If we're going to issue a new release, freeze the code one week early(it depends, but usually it's one week), ensure we have enough time for related testing.

@Dengjianping
Copy link
Contributor Author

Before merge this pr, I need to check whether changes in benchmark should be minor.

@Dengjianping Dengjianping self-assigned this Feb 15, 2022
@Dengjianping Dengjianping added A-ci Area: Continuous Integration C-enhancement Category: An issue proposing an enhancement or a PR with one labels Feb 15, 2022
@Dengjianping Dengjianping added this to the v3.1.5 milestone Feb 15, 2022
Copy link
Contributor

@ghzlatarev ghzlatarev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You have the same description for opt-level and codegen-units

@Dengjianping
Copy link
Contributor Author

Dengjianping commented Feb 15, 2022

Do we need another profile? Like

[profile.testnet]
inherits = "release"
panic = "unwind"

Current profile.release is for production, it will take too much time for compiling while development.

Cargo.toml Outdated Show resolved Hide resolved
Copy link
Contributor

@ghzlatarev ghzlatarev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please mention mention in the description the name of the new profile explicitly, and how to use it and the new target folder.

@Garandor
Copy link
Contributor

https://github.com/Manta-Network/Manta#build-mantacalamari-node
build instructions need update to --prod

@stechu
Copy link
Contributor

stechu commented Feb 20, 2022

Is there a way that we can control the rust version when people use cargo b?

@Dengjianping
Copy link
Contributor Author

Dengjianping commented Feb 21, 2022

Is there a way that we can control the rust version when people use cargo b?

Thanks for the suggestion! But actually we has specified msrv in our readme, seems it's not enough.

There're three ways to tell people msrv:

  1. rust-version = '1.57' in Cargo.toml.
  2. msrv = "1.57.0" in clippy.toml.
  3. Add a toolchain file rust-toolchain which specify a msrv.

I prefer option 1, it's a new feature in rust 2021.
And it will pop a hint like:

cannot be built because it requires rustc 1.61 or newer, while the currently active rustc version is 1.58.1

@stechu stechu merged commit 13dfd01 into manta Feb 23, 2022
@stechu stechu deleted the jamie/customize-profile branch February 23, 2022 19:59
dziabko pushed a commit that referenced this pull request Mar 8, 2022
* Move rustc flags to cargo profile

* Add msrv=1.57 to cargo.toml

* Use build subcommand
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-ci Area: Continuous Integration C-enhancement Category: An issue proposing an enhancement or a PR with one
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Utilize profile feature in cargo.toml
4 participants