Add rust README.md #21
Conversation
Co-authored-by: Alex Couture-Beil <alex@earthly.dev>
rust/README.md
Outdated
| ARG --global debian = bookworm | ||
|
|
||
| # Importing via commit hash pinning because git tags can be changed | ||
| IMPORT github.com/earthly/lib/rust:4cfebf74b5805ad943d325a94601e808afbf6e6f AS rust |
There was a problem hiding this comment.
I know that tags can be changed, but changing them for released software is something you don't normally do. It might be good to start maintaining some official semver versions + tags for these subpackages. It would help users to keep track a bit better.
Perhaps the tags can be specific to a sub-package. e.g. rust-0.1.0.
There was a problem hiding this comment.
@vladaionescu why would we need semvers for specific packages and not for the whole repo?
There was a problem hiding this comment.
Mainly because the compatibility guarantees might be better if they're isolated. Like if we break compatibility for rust, why have the go users worry about it?
There was a problem hiding this comment.
yeah, but users can always look at the release notes, no? I just think it makes it harder (or at least eventually harder) to maintain
There was a problem hiding this comment.
@vladaionescu I just feel like it's one of those things that can be addressed if and when it becomes a problem.
There was a problem hiding this comment.
Basically we would be breaking the semantics we are aiming to achieve. Is it truth that in a soft-way, but still we would be sending a confusing message:
- Let's say I introduce a breaking change in
rust, and increase the major version, thengousers would perceive such version change and lose their stream of automatic updates - As an API user, it would be confusing and disappointing for me performing version updates that actually don't include any improvements. These changes just won't follow the semver specification
There was a problem hiding this comment.
@idelvall , @vladaionescu
I suggest having a 5 minute discussion on this in our next core/work chats (or ad-hoc if we don't want to wait until then) before we commit to this.
|
|
||
| First, import the UDC up in your Earthfile: | ||
| ```earthfile | ||
| IMPORT github.com/earthly/lib/rust:<version/commit> AS rust |
There was a problem hiding this comment.
Nit: AS rust isn't actually necessary when the name is the same. But also it doesn't hurt.
There was a problem hiding this comment.
I think it is more readable
No description provided.