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

src: make a single-binary only project #113

Merged
merged 3 commits into from Aug 20, 2018
Merged

Conversation

lucab
Copy link
Contributor

@lucab lucab commented Aug 17, 2018

This ensures that the coreos-metadata crate only provides a single
binary. The corresponding library is not supposed to be externally
consumed and is not guaranteed to have a stable API (at the moment).

It also updates dependencies and adjusts cargo manifest for publishing
the next version.

This ensures that the coreos-metadata crate only provides a single
binary. The corresponding library is not supposed to be externally
consumed and is not guaranteed to have a stable API (at the moment).
@lucab lucab requested review from sdemos and csssuf August 17, 2018 13:51
This updates all dependencies within their compatible semver ranges.
This adds all required fields for publishing on crates.io.
@lucab
Copy link
Contributor Author

lucab commented Aug 17, 2018

@sdemos @csssuf please double-check me, but I think we were not aiming at providing a public library (at least for now). Given that I'd like to upload this to crates.io, I think it would be better not to expose that at all.

@sdemos
Copy link
Contributor

sdemos commented Aug 17, 2018

yeah, the primary purpose is definitely just to provide the binary. There isn't really a good reason to pin ourselves in by exposing the library part at this point, at least as far as I can see.

Copy link
Contributor

@csssuf csssuf left a comment

Choose a reason for hiding this comment

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

I suppose technically this requires a 3.0 🙂

@lucab
Copy link
Contributor Author

lucab commented Aug 20, 2018

@csssuf why? We never published the crate and we are dropping the library, so the semver does not apply to that. For the binary, IMHO the versioning is pretty much arbitrary. I think we will need to bump to 3.0 if/when we want to re-introduce the public library.

@lucab
Copy link
Contributor Author

lucab commented Aug 20, 2018

I'm merging this for now. I am happy to continue the versioning discussion here and account for that when preparing the next release PR.

@lucab lucab merged commit f2e1eaf into coreos:master Aug 20, 2018
@csssuf
Copy link
Contributor

csssuf commented Aug 21, 2018

@lucab We bumped to 2.0.0 when we changed the API of the library portion for the MetadataProvider trait, but if we don't think there are any actual consumers of the library then I'd be fine sticking with 2.0.

@lucab
Copy link
Contributor Author

lucab commented Aug 21, 2018

@csssuf my reasoning is that:

  1. for 2.0.0, there can't be any stable consumer of this library as we never published it to crates.io
  2. for (an hypothetical) 3.0.0, there can't be any stable consumer of this library as the library (as in extern crate coreos-metadata) does not exist anymore

If the first is not true, then your concern is valid. In that case, I think it may be safer to just bump to 3.0.0 and be done with the library. People (if any) could still lock into library 2.0.0 via git dependency.

lucab added a commit to lucab/afterburn that referenced this pull request Aug 22, 2018
This prepares for the next major version. For rationale, see
coreos#113 (comment)
lucab added a commit to lucab/afterburn that referenced this pull request Aug 22, 2018
This prepares for the next major version. For rationale, see
coreos#113 (comment)
lucab added a commit to lucab/afterburn that referenced this pull request Aug 22, 2018
This prepares for the next major version. For rationale, see
coreos#113
@lucab
Copy link
Contributor Author

lucab commented Aug 22, 2018

As the outcome of this discussion, to be on the safe side I'm bumping the current development series version in #114.

@lucab lucab added this to the v3.0.0 milestone Aug 24, 2018
@lucab lucab deleted the ups/bin-only branch November 5, 2018 11:31
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