search

blue-build / website

Website that hosts BlueBuild documentation.
https://blue-build.org/
Apache License 2.0
6 stars 4 forks source link

docs: how to build and test locally #45

Closed michaelhaaf closed 3 months ago

michaelhaaf commented 3 months ago

Figured since I'm going through the motions of setting up local testing, I might as well document how I'm doing it.

netlify[bot] commented 3 months ago

Deploy Preview for cozy-cascaron-6c7990 ready!

Name Link
Latest commit d39d6716330605b57f85462b8b4fe8bb05bd9ecc
Latest deploy log https://app.netlify.com/sites/cozy-cascaron-6c7990/deploys/66085cfbd0d3bf000851f4d9
Deploy Preview https://deploy-preview-45--cozy-cascaron-6c7990.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

xynydev commented 3 months ago

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.

michaelhaaf commented 3 months ago

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 https://github.com/blue-build/cli/issues/65 and https://github.com/blue-build/website/issues/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 caution blocks.

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.

xynydev commented 3 months ago

This is really great! I agree about merging even before the refactor. I'll give some comments on this right now.

xynydev commented 3 months ago

Great work! Still planning to add the missing sections?

michaelhaaf commented 3 months ago

@xynydev build is the only command I really used, this is all I was planning to write at this time

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.

xynydev commented 3 months ago

Aight, I'm going to merge this then, and fill in later with the rest of the details.