Skip to content

Use cargo make #133

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

Merged
merged 3 commits into from
Aug 31, 2020
Merged

Use cargo make #133

merged 3 commits into from
Aug 31, 2020

Conversation

russcam
Copy link
Contributor

@russcam russcam commented Aug 27, 2020

This PR adds a Makefile.toml including tasks to help with the development of the project. Update CONTRIBUTING.md to detail typical cargo make usage.

Cargo make lays the foundation for further improvements:

  • remove the usage of rustfmt-nightly crate in api_generator and use the cargo make format task to format generated code. This will allow all packages to run on stable channel
  • add a cargo make task to generate the README.md from the lib.rs module comment, removing the need to maintain both, whilst still allowing testing of doc code snippets

This commit adds a Makefile.toml including tasks to
help with the development of the project.

Update CONTRIBUTING.md to detail typical cargo make
usage.
@russcam russcam requested a review from swallez August 27, 2020 02:57
This commit removes the use of rustfmt-nightly crate
and instead invokes the format task with cargo make
to format generated code.

This change allows all projects to compile and
run on rust stable channel
Copy link
Member

@swallez swallez left a comment

Choose a reason for hiding this comment

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

Nice stuff! Our build is specific enough that a standard Cargo.toml isn't enough.

I added a suggestion about replacing the default task with a "welcome" message.

@russcam russcam merged commit 8416c4f into master Aug 31, 2020
russcam added a commit that referenced this pull request Aug 31, 2020
* Use cargo make

This commit adds a Makefile.toml including tasks to
help with the development of the project.

Update CONTRIBUTING.md to detail typical cargo make
usage.

* Remove rustfmt-nighly crate

This commit removes the use of rustfmt-nightly crate
and instead invokes the format task with cargo make
to format generated code.

This change allows all projects to compile and
run on rust stable channel

(cherry picked from commit 8416c4f)
russcam added a commit that referenced this pull request Aug 31, 2020
* Use cargo make

This commit adds a Makefile.toml including tasks to
help with the development of the project.

Update CONTRIBUTING.md to detail typical cargo make
usage.

* Remove rustfmt-nighly crate

This commit removes the use of rustfmt-nightly crate
and instead invokes the format task with cargo make
to format generated code.

This change allows all projects to compile and
run on rust stable channel

(cherry picked from commit 8416c4f)
@russcam russcam deleted the cargo-make branch September 3, 2020 03:13
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.

2 participants