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

Add script to check rust versions + cleanup #272

Merged
merged 17 commits into from
Mar 14, 2024
Merged

Add script to check rust versions + cleanup #272

merged 17 commits into from
Mar 14, 2024

Conversation

phklive
Copy link
Contributor

@phklive phklive commented Mar 11, 2024 •
edited
Loading

In this pr after @bobbinth 's review on #251 added a few improvements:

  • bash script enabling the check of correct rust versions in the whole repo ( rust-toolchain and Cargo.tomls ) we will have other bash scripts in the repo in the future for end-to-end testing for example, hence I believe that it does not hurt to add it to the repo now.
  • added bash script version check to ci ( will be able to add it to pre-commit in the future )
  • added msrv in all cargo.toml files
  • removed unnecessary comments from .gitignore file and improved formatting

@phklive phklive requested review from bobbinth and hackaugusto March 11, 2024 21:17
@phklive phklive mentioned this pull request Mar 11, 2024
Merged
@bobbinth bobbinth changed the base branch from main to next March 11, 2024 22:22
bobbinth
bobbinth reviewed Mar 11, 2024
View reviewed changes
Copy link
Contributor

@bobbinth bobbinth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Thank you! I left a couple of questions inline.

Also, should we add "Testing" section to the main readme to explain how to run tests?

@phklive
Copy link
Contributor Author

phklive commented Mar 12, 2024

Looks good! Thank you! I left a couple of questions inline.

Also, should we add "Testing" section to the main readme to explain how to run tests?

Added a section for testing in the Contributing.md

bobbinth
bobbinth reviewed Mar 12, 2024
View reviewed changes
bobbinth
bobbinth reviewed Mar 12, 2024
View reviewed changes
bobbinth
bobbinth reviewed Mar 12, 2024
View reviewed changes
bobbinth
bobbinth reviewed Mar 12, 2024
View reviewed changes
bobbinth
bobbinth reviewed Mar 13, 2024
View reviewed changes
Copy link
Contributor

@bobbinth bobbinth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! I left a few comments inline. These comments are applicable to most Cargo.toml files in this repo.

bobbinth
bobbinth approved these changes Mar 14, 2024
View reviewed changes
Copy link
Contributor

@bobbinth bobbinth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Thank you! I left one minor nit inline. Once this is addressed, we can merge.

@phklive phklive merged commit 5c79ccb into next Mar 14, 2024
5 checks passed
@phklive phklive deleted the phklive-fix-gitignore-comments branch March 14, 2024 09:45
bobbinth pushed a commit that referenced this pull request Apr 12, 2024
@phklive @hackaugusto @bobbinth
Add script to check rust versions + cleanup (#272)
2a8f37a 
* ci: turn doc warnings into errors (#259)

* remove unnecessary comments

* Add script to check rust versions

* removed versions and editions except from root, updated script

* add back cargo make doc to ci

* Added section for testing

* Fixed typo

* Set versions to 0.1.0 + inherit all infos from workspace

* Fix use of versioning

* Set individual versions for crates

* Fixed nits, code organization and updated links

* Improve naming of ci job

* Fix formatting in contributing.md

* Add task to format not only check

* Reduced indent

---------

Co-authored-by: Augusto Hack <hack.augusto@gmail.com>
@Mirko-von-Leipzig Mirko-von-Leipzig mentioned this pull request Jul 18, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bobbinth bobbinth bobbinth approved these changes

@hackaugusto hackaugusto Awaiting requested review from hackaugusto

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@phklive @bobbinth @hackaugusto