Some build improvements

spyglass-search / spyglass

A personal search engine: Create a searchable library from your personal documents, interests, and more!

https://docs.spyglass.fyi

GNU Affero General Public License v3.0

2.5k stars 56 forks source link

Some build improvements #511

Closed DrChat closed 3 months ago

DrChat commented 5 months ago

cargo build --all now works from a clean checkout. Good for helping onboard new developers that are used to running that command.
- This also fixes stuff like cargo check, which rust-analyzer depends on.
Tauri
- Relocated tauri crate to apps folder to designate it as a "frontend app"
- Removed sidecar settings from default config since these binaries are not required to be packaged in a development build. TODO: Need to apply the rel config to "publish" builds so that they are still bundled.
Added a "tl;dr" section to the readme to give developers a very quick command they can run to start up Spyglass from their clone.

But...

Broke the Makefile. Thoughts on just redirecting it to cargo make and consolidating?

a5huynh commented 5 months ago

Thanks @DrChat for putting this together, I'll take a look at this later today. Is this pretty much ready to go (outside of the broken Makefile, which I can take a look at fixing)

DrChat commented 5 months ago

It's not quite yet ready to go - there's still some TODOs like with the Makefile and using the rel config for releases. I'm also looking at whether or not the logic in the yaml workflows can be extracted into a separate helper, like cargo-xtask.

Feel free to push commits to this PR if you want to look at the Makefile.

PS: I noticed that the documentation for developers has become stale. Not sure where the code is for it though :)

DrChat commented 5 months ago

@a5huynh I think this is good to go now - the YAML changes can probably be saved for another PR since it'll require more work than I thought.

There was another annoying issue where trunk keeps deleting the .gitkeep file and it's really easy to accidentally commit. Not sure what to do about it since that folder needs to exist on a fresh checkout. NM, found a workaround :)

a5huynh commented 5 months ago

@DrChat awesome thanks for getting this together! I'll have some time this weekend to review things