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.

Sign up for GitHub

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

Jump to bottom

Remove duplicated README #1053

Closed
caspermeijn opened this issue May 8, 2024 · 1 comment · Fixed by #1078
Closed

Remove duplicated README #1053

caspermeijn opened this issue May 8, 2024 · 1 comment · Fixed by #1078

Comments

@caspermeijn
Copy link
Collaborator

caspermeijn commented May 8, 2024 •
edited

To unblock the release process, I have duplicated the README into the prost crate (#1052). This should be removed.

I see two solutions:

  1. Split the readme into:
  • README.md for how to use the repository
  • prost/README.md for an explanation of the crate prost
  • prost/lib.rs for instructions on using the prost crate

The other crates in the repo have a similar split README.md and lib.rs

  1. Tokio has solved this differently. They have a duplicated README and a CI job to check they keep in sync. https://github.com/tokio-rs/tokio/blob/e62c3e92692f795c407beadff580fa1380df5a26/.github/workflows/ci.yml#L798-L808
@LucioFranco
Copy link
Member

We should follow what tokio does, I think that makes the most sense to me.

caspermeijn added a commit to caspermeijn/prost that referenced this issue May 27, 2024
@caspermeijn
ci: Ensure both README are the same and prost version is correct
83e07c5 
Fixes tokio-rs#1053
caspermeijn added a commit to caspermeijn/prost that referenced this issue May 27, 2024
@caspermeijn
ci: Ensure both README are the same and prost version is correct
9d27023 
Fixes tokio-rs#1053
@caspermeijn caspermeijn mentioned this issue May 27, 2024
Merged
github-merge-queue bot pushed a commit that referenced this issue May 27, 2024
@caspermeijn
ci: Ensure both README are the same and prost version is correct (#1078)
52ff081 
* ci: Ensure both README are the same and prost version is correct

Fixes #1053

* docs: Update prost version in README

* build: Fix prepare-release.sh for README
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

ci: Ensure both README are the same and prost version is correct caspermeijn/prost
2 participants
@caspermeijn @LucioFranco