docs: how to build and test locally #45
Conversation
✅ Deploy Preview for cozy-cascaron-6c7990 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Thanks! I've been intentionally holding off on adding this page, as the commands used to generate the Containerfile and switch to the local build will be refactored soon. The installation instructions should be offloaded to the CLI README. Appreciate the work on that front too, feel free to PR those changes in there. |
Add instructions for installing (especially via distrobox), configuring, and using bluebuild for local development, especially emphasising `bluebuild build` for local development/debugging broken GitHub Action builds.
michaelhaaf
changed the title
|
Sounds good @xynydev -- I've separated out the installation and distrobox tips into a PR for the cli readme as you've suggested (see here). I did happen to see blue-build/cli#65 and #22 after I got started on this, and I can appreciate waiting until the interface is finalized before pushing this. What I have done in the time since you last looked is marked certain sections that will be affected by the refactor with I want to suggest that this doc could be incorporated even before the interface change? Though I'm not certain how much you intend to change. My motivation for doing this documentation change was fundamentally about trying to understand why my github action builds were failing. Regardless of the upcoming interface change, I have found it valuable to be able to reliabily (i.e. without forgetting how to set things up) reproduce local builds; if my github action builds continue to fail, I could point to these docs to show what I've done to experiment. If that makes sense? I'm happy to parse this down to the parts that you're sure won't change (one possible e.g., the bash completions section). I'm also equally happy to drop this and let it be done after the interface refactor. |
I had initially added distrobox installation instructions to the website (see [here](blue-build/website#45), but it has been suggested that the CLI readme is a more natural place for them. I have tested the distrobox installation method and procedures on my home machine and aside from an odd bug (see #145) everything is working.
|
This is really great! I agree about merging even before the refactor. I'll give some comments on this right now. |
Co-authored-by: xyny <60004820+xynydev@users.noreply.github.com>
Co-authored-by: xyny <60004820+xynydev@users.noreply.github.com>
|
Great work! Still planning to add the missing sections? |
|
@xynydev Edit: it's speculative since I haven't done it yet, but I'm planning to try a workflow using local builds for testing vms on a local kvm/qemu/virt-manager setup. That would give this tutorial a bit more reason to exist, if it's sparse as is. But that might be a while before I get to it, we'll see. |
A few more tips/tricks I wrote for blue-build/website#45 that make more sense in the README
|
Aight, I'm going to merge this then, and fill in later with the rest of the details. |
Figured since I'm going through the motions of setting up local testing, I might as well document how I'm doing it.