Option to leave OCI container alive for debugging after build

[Helveg]

Description

When experimenting with the local setup, using cibuildwheel --platform=linux, for example, a container is created. The container is removed after the build finishes. If the build fails, there's no way to debug what caused it except for the logs. The roundtrip time of adding debug logs are pretty high for big software projects. For myself I've commented out these lines:

cibuildwheel/cibuildwheel/oci_container.py

Lines 148 to 152 in f766904

	subprocess.run(
	[self.engine, "rm", "--force", "-v", self.name],
	stdout=subprocess.DEVNULL,
	check=False,
	)

But I could PR a proper solution if someone talks me through the requirements, and if everyone agrees this is a good addition for debugging.

Build log

No response

CI config

No response

[Helveg]

@henryiii sorry to tag you, but 1 year later, and still willing to PR this ^_^

[henryiii]

I'd be okay with an environment variable to disable the cleanup. CIBW_CONTAINER_DEBUG or something like that? @joerick, @mayeut?

[joerick]

Yeah, that would be fine. CIBW_DEBUG_KEEP_CONTAINER might make sense. IMO it doesn't have to go through all the options.py machinery, it can be a simple os.environ.get, as we don't care about reading from TOML etc. I think we could add a little section to the bottom of the options documentation page to note little extra options that are more for debugging. The other one that doesn't fit with the other options is CIBW_CACHE_PATH, that could be documented there too.