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

Replace .version files with a single .shards.info #366

Merged
merged 3 commits into from
Apr 28, 2020

Conversation

waj
Copy link
Member

@waj waj commented Apr 27, 2020

Since #349 every installed shard is accompanied by a .version file with the real installed version. This clutters the lib directory. This PR replaces all those files with a single lib/.shards.info file. This file is also a YAML so the contents could be extended in the future with any required metadata.

@waj
Copy link
Member Author

waj commented Apr 27, 2020

Note that the previous change is not released yet. So a migration path is unnecessary.

@Sija
Copy link
Contributor

Sija commented Apr 27, 2020

I'd suggest naming the file .shards.yml (or similar but with the .yml extname), since it is an YML file after all.

@waj
Copy link
Member Author

waj commented Apr 27, 2020

@Sija I think that name could be confused with shard.yml. Also, the shard.lock file is also a yml and yet it has a different extension.

@bcardiff
Copy link
Member

@Sija since the two files have different semantics and different schema I don't think is good to name them so similar. .shards.info is fine.

@straight-shoota
Copy link
Member

@Sija This is only for internal use and the fact that it's based on a YAML format is an implementation detail. We could decide to change the representation at any point and still keep the same file name.

@straight-shoota
Copy link
Member

We could consider naming the file shards.installed or shards.versions to better express the purpose. But I'm fine with shards.info.

@waj waj merged commit 00f0c3b into crystal-lang:master Apr 28, 2020
@waj waj added this to the v0.11.0 milestone Apr 28, 2020
@waj waj deleted the shards-info-file branch April 28, 2020 15:10
taylor pushed a commit to vulk/shards that referenced this pull request Aug 11, 2020
f-fr pushed a commit to f-fr/shards that referenced this pull request Jan 2, 2021
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

5 participants