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

Preparing for open-sourcing #14

Merged
merged 2 commits into from
May 20, 2024
Merged

Conversation

ykitamura-mdsol
Copy link
Contributor

Updated docs to get ready for open-sourcing

@mdsol/architecture-enablement

@@ -2,6 +2,9 @@
name = "mauth-core"
version = "0.4.1"
edition = "2021"
authors = ["Medidata Solutions <support@mdsol.com>"]
license = "MIT"
repository = "https://github.com/mdsol/mauth-core"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

do we need anything else?

Copy link
Member

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

Choose a reason for hiding this comment

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

I think this needs a number of other fields in order to publish to crates.io. See the list in the docs here. You should use the cargo publish --dry-run command locally to verify that everything is valid. See the section in my crate for an example.

Your dependency list is also not very good for a crate. All of your dependencies should have much looser constraints that reflect what the code actually requires; nothing should be =. As is, I believe you would be requiring any crate that integrated with yours to use the exact same versions of every dependency you have.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

the cargo publish --dry-run just complained about missing the description field but added some other fields also in 706ac9d

nothing should be =.

The cargo book says this so I think it is good as-is...

Although it looks like a specific version of the time crate, it actually specifies a range of versions and allows SemVer compatible updates.

Copy link
Member

Choose a reason for hiding this comment

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

Interesting, I was not aware of that regarding = in Cargo.toml. Looks good to me now then.

@ykitamura-mdsol
Copy link
Contributor Author

cc @glow-mdsol

Copy link
Contributor

@jcarres-mdsol jcarres-mdsol left a comment

Choose a reason for hiding this comment

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

LGTM

@@ -2,6 +2,9 @@
name = "mauth-core"
version = "0.4.1"
edition = "2021"
authors = ["Medidata Solutions <support@mdsol.com>"]
license = "MIT"
repository = "https://github.com/mdsol/mauth-core"
Copy link
Member

Choose a reason for hiding this comment

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

Interesting, I was not aware of that regarding = in Cargo.toml. Looks good to me now then.

@jcarres-mdsol jcarres-mdsol merged commit 9c5e129 into main May 20, 2024
2 checks passed
@jcarres-mdsol jcarres-mdsol deleted the feature/preparing_opensource branch May 20, 2024 21:06
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.

4 participants