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

[Improvement]: update our docs to use recommended alternatives to deprecated cargo watch #1944

Open
1 task done
oddgrd opened this issue Dec 30, 2024 · 5 comments
Open
1 task done
Assignees
Labels
S-Accepted This will be worked on T-Improvement Improvement or addition to existing features

Comments

@oddgrd
Copy link
Contributor

oddgrd commented Dec 30, 2024

Describe the improvement

Cargo watch will eventually start failing due to no longer being maintained, so it would be good to update our docs to the recommended alternatives. I do like the one-liner we had, but it still requires the user to install a separate binary, so it still require some effort either way. We should consider having both in the docs, the option to use watchexec and the one-liner you can use it with, as well as a suggestion to use bacon, with a proposed config to make it convenient to use with shuttle.

Duplicate declaration

  • I have searched the issues and this improvement has not been requested before.
@oddgrd oddgrd added T-Improvement Improvement or addition to existing features S-Accepted This will be worked on labels Dec 30, 2024
@c-git
Copy link
Contributor

c-git commented Dec 30, 2024

Thanks, got it. Addling the link to the file to be updated https://github.com/shuttle-hq/shuttle-docs/blob/main/docs/local-run.mdx#development-tips

@c-git
Copy link
Contributor

c-git commented Jan 2, 2025

bacon may actually land one liners do we want to do the update after we know how that goes (PS. I don't know how long it would take to land)?

I'm just wondering if it's worth the wait?

@oddgrd
Copy link
Contributor Author

oddgrd commented Jan 3, 2025

It's no rush, cargo watch will keep working for a while, so feel free to wait on that if you'd prefer that! It looks quite close too!

@c-git
Copy link
Contributor

c-git commented Jan 3, 2025

Ok thanks, he's going to release a experimental version. I'll write up the docs once that's out and we'll just wait to merge after it stabilizes. Writing it up will help test the design to see how it feels. Once the draft is ready I'll reach out for feedback to see how you find it looks.

@oddgrd
Copy link
Contributor Author

oddgrd commented Jan 3, 2025

Sounds great, thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-Accepted This will be worked on T-Improvement Improvement or addition to existing features
Projects
None yet
Development

No branches or pull requests

2 participants