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

Include version number in README of each crate #41

Open
ggwpez opened this issue Aug 22, 2024 · 5 comments
Open

Include version number in README of each crate #41

ggwpez opened this issue Aug 22, 2024 · 5 comments

Comments

@ggwpez
Copy link
Member

ggwpez commented Aug 22, 2024

The README of each crate should mention the version number at the end. This makes it possible to reverse-lookup into what release a crate version was included.

@Morganamilo
Copy link
Collaborator

What's the plan for this? A magic sed is the only way I can think to do it but that feels messy and easily breakable if some one changes the readme format unknowingly.

@ggwpez
Copy link
Member Author

ggwpez commented Aug 29, 2024

What's the plan for this? A magic sed is the only way I can think to do it but that feels messy and easily breakable if some one changes the readme format unknowingly.

Hm not sure i get what you mean, so maybe Im oversimplifying it but can we do something like this?
echo "\nThe corresponding Polkadot-SDK release for this version is: $VERSION" >> README.md

@Morganamilo
Copy link
Collaborator

I guess that works if we want it right at the bottom of the readme.

@Morganamilo
Copy link
Collaborator

I've written it so it appends

## Release

{description}

where description is something like Polkadot SDK v1.2.3.

It's this way because the tool should be repo agnostic so I don't want to hardcode polkadot into the sentence and I generally prefer readme's to be less wordy.

Let me know if this wording works for you.

@ggwpez
Copy link
Member Author

ggwpez commented Sep 3, 2024

Yep sounds good, thanks!
Then what do we do with the crate description? crates-io only shows the latest description which is then wrong for old versions. Maybe we should remove it to avoid confusion?

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

No branches or pull requests

2 participants