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

feat(ci): add CI to the project #4

Merged
merged 3 commits into from
Nov 12, 2024
Merged

feat(ci): add CI to the project #4

merged 3 commits into from
Nov 12, 2024

Conversation

raskyld
Copy link
Collaborator

@raskyld raskyld commented Nov 9, 2024

  • Add GitHub workflow to run cargo make ci-flow on push to main and in PRs,
  • Leverage sensible default from cargo-make,
  • Use the same fmt than the monorepository,
  • Fix Doc Tests so they compile,
  • Update dependencies to use latest main until we stabilise,
  • Reformat the codebase to comply with CI,
  • Explicitly request nightly toolchain.

* Add GitHub workflow to run `cargo make ci-flow`
  on push to main and in PRs,
* Leverage sensible default from `cargo-make`,
* Use the same fmt than the monorepository,
* Fix Doc Tests so they compile,
* Update dependencies to use latest main until we stabilise,
* Reformat the codebase to comply with CI,
* Explicitly request `nightly` toolchain.

Signed-off-by: Enzo "raskyld" Nocera <[email protected]>
Signed-off-by: Enzo "raskyld" Nocera <[email protected]>
Signed-off-by: Enzo "raskyld" Nocera <[email protected]>
@raskyld
Copy link
Collaborator Author

raskyld commented Nov 9, 2024

cc @ogghead you may wanna have a 👀 on that as well!

@raskyld raskyld requested a review from benwis November 9, 2024 11:19
@@ -0,0 +1,2 @@
[toolchain]
channel = "nightly-2024-11-01"
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you elaborate on why nightly is needed? If we need to rely on nightly-only features, my understanding is that would force consumers of this crate to use nightly too. But it is definitely possible that I am overthinking the impact downstream, so curious to hear your thoughts!

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Good question, I think most people will use nightly because of : https://book.leptos.dev/deployment/binary_size.html so they can rebuild the standard library with optimisation, also I did that because the cargo project itself use nightly for its CI, but maybe nightly is not fundamentally needed and once we stabilise the crate we can think about using stable rust

Copy link
Contributor

Choose a reason for hiding this comment

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

Fair , there are many optimizations in nightly -- maybe I am overblowing the impact if this crate doesn't use nightly code logic features. Thanks for the explanation

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Oh no I think your concern is valid!
Actually, you should even open an issue so we look back at it once we start stabilizing the crate.

@ogghead
Copy link
Contributor

ogghead commented Nov 9, 2024

Nice, I haven't seen cargo-make before, cool stuff 😄 Thanks for creating this PR!

Just had one comment/question on nightly usage, overall lgtm

@benwis
Copy link
Contributor

benwis commented Nov 10, 2024

LOL There's a little bit more to this PR than just a GH action

@benwis benwis merged commit d6d6469 into main Nov 12, 2024
1 check passed
@benwis
Copy link
Contributor

benwis commented Nov 12, 2024

All looked good to me, thanks for y'alls work on this

@benwis benwis deleted the enocera/ci-cd branch November 12, 2024 18:37
@ogghead ogghead mentioned this pull request Nov 19, 2024
2 tasks
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.

3 participants