docs: add commented out `maximize_build_space: true` to build.yml

[johnr14]

docs: add commented out `maximize_build_space: true` to build.yml

[fiftydinar]

We already documented the use of "Maximize build space" action as an option in build.yml.

https://blue-build.org/reference/github-action/#maximize_build_space-optional

Try to input the option in build.yml as outlined above, as it's different from ublue-os "Maximize build space" action.

We use this one:

https://github.com/jlumbroso/free-disk-space

[johnr14]

I was looking at the code and found the solution

      uses: jlumbroso/[email protected]
      if: ${{ inputs.maximize_build_space == 'true' }}

Just a bit before I saw your reply.

It did build with my image with the ublue-os action.
Did the rebuild with free-disk-space and it resulted in : Saved 4.7GiB

Sorry my fault for not seeing it in the documentation.

I'd would have preferred the template to include all sane options with their default and commented out. It would make it more self explanatory.

Just pasting in case someone else search issues instead or reading the docs :)

      - name: Build Custom Image
        uses: blue-build/[email protected]
        with:
          recipe: ${{ matrix.recipe }}
          cosign_private_key: ${{ secrets.SIGNING_SECRET }}
          registry_token: ${{ github.token }}
          pr_event_number: ${{ github.event.number }}
          #use_unstable_cli: false # this action pulls the main branch of blue-build/cli instead of the stable version
          maximize_build_space: true # run the unwanted software remover to maximize build space 
          squash: true

Thanks for your great work !

[fiftydinar]

The reason why we don't include "Maximize Build Space" by default is that it's not required for all images, while it increases the time of image building.

But commenting out the additional options in template & explaining them might be a good idea.
Will see if @xynydev also agrees.

[xynydev]

Yes, that's a good idea especially for a common usecase like this. I'll reopen the issue so we get it done eventually.