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

Prepare rust crates' metadata for publishing #3945

Merged
merged 2 commits into from
Jun 5, 2023
Merged

Prepare rust crates' metadata for publishing #3945

merged 2 commits into from
Jun 5, 2023

Conversation

andreacorbellini
Copy link
Contributor

Summary

Added description, keywords, and links to the crates that will be published to crates.io (plus a few more crates for consistency).

Also added a version number to the ironfish-rust -> ironfish-zpk dependency: this version number will be required in order to publish ironfish-rust to crates.io.

Testing Plan

Ran cargo publish --dry-run for ironfish-zkp, and inspected the resulting .crate files. Relevant output:

[package]
edition = "2021"
name = "ironfish_zkp"
version = "0.1.0"
authors = ["Iron Fish <contact@ironfish.network> (https://ironfish.network)"]
description = "Sapling API and zero-knowledge proving mechanism for the Iron Fish node"
homepage = "https://ironfish.network/"
readme = "README.md"
keywords = [
    "iron-fish",
    "sapling",
    "zero-knowledge",
]
license = "MIT OR Apache-2.0"
repository = "https://github.com/iron-fish/ironfish"
resolver = "1"

It is not possible at the moment to run cargo publish --dry-run for ironfish-rust because ironfish-zkp needs to be published first.

Documentation

N/A

Breaking Change

Not a breaking change

@andreacorbellini andreacorbellini requested a review from a team as a code owner June 5, 2023 21:08
@@ -3,12 +3,21 @@ name = "ironfish_rust"
version = "0.1.0"
license = "MPL-2.0"

description = "Rust create for interacting with transactions on the Iron Fish chain"
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
description = "Rust create for interacting with transactions on the Iron Fish chain"
description = "Rust crate for interacting with transactions on the Iron Fish chain"

Added additional metadata to the Rust crates, in particular to
`ironfish_rust` and `ironfish_zkp`.
The version number will be required for publishing to crates.io.
@andreacorbellini andreacorbellini merged commit 72daa75 into iron-fish:staging Jun 5, 2023
11 checks passed
@andreacorbellini andreacorbellini deleted the andrea/ifl-1070-prepare-rust-crates-metadata-for-publishing branch July 28, 2023 17:51
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.

None yet

3 participants