-
Notifications
You must be signed in to change notification settings - Fork 83
Switch to cargo-readme
for README generation
#29
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
Conversation
Note: This commit should fail on CI because the readmes do not match.
Note: Use absolute links for CODE_OF_CONDUCT and CONTRIBUTING so that we can click on this links also on docs.rs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for this PR 🎉, I like how it turned out. Just some minor comments.
Could there also be a better message when the diff fails? E.g. "README.md out of date. Run cargo readme > README.md
and commit again.".
if [ $? -eq 0 ]
then
echo "README.md is up to date!"
exit 0
else
echo "README.md out of date. Run `cargo readme > README.md` and commit again."
exit 1
fi
cargo-readme
for README generation
Could we also add a sentence to the CONTRIBUTING.md file documenting the additional step of running |
Also move files into own folder. Remove this test branch from the travis
b4d57bf
to
0d27c62
Compare
According to the |
Seems like I forgot to add a Pull Request Template indeed. It should be added under
The broken link you found can be fixed by changing the file to |
@senden9 |
I do not know where |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@senden9 Thank you for creating this PR! 🎉It will be very helpful in keeping code and README up-to-date!
I wish you continued success with Hacktoberfest!
|
Fixes #28.
See https://travis-ci.org/senden9/influxdb-rust/jobs/595985325 for a check that failed because of a non-matching readme.
See https://travis-ci.org/senden9/influxdb-rust/jobs/596020860 for a passed check because of a readme that is in sync.
Please check the 'Planned Features" because I simply merged the two different lists and subtracted the "Currently Supported Features".