Add documentation for the --build-id-pat option

[travishathaway]

Checklist

• I added a descriptive title
• I searched open requests and couldn't find a duplicate

What is the idea?

The --build-id-pat is currently poorly documented. There is no information on how to provide a meaningful value for this configuration option.

Why is this needed?

To reduce confusion around this configuration option.

What should happen?

• Add documentation for this option to the CLI and the documentation website. This documentation should include the template variables that can be used and an example of its usage.

Additional Context

This issue was created in response to concerns initially brought up in this issue:

• Build error related to os.getcwd() on linux. Only works with --no-build-id conda-package-handling#205

[travishathaway]

I dug around the code a little bit and discovered that it defaults to the following:

conda-build/conda_build/cli/main_build.py

Lines 235 to 243 in ccc3e81

	p.add_argument(
	"--build-id-pat",
	help=(
	"specify a templated pattern to use as build folder names. Use if having issues with "
	"paths being too long."
	),
	dest="build_id_pat",
	default=cc_conda_build.get("build_id_pat", "{n}_{t}"),
	)

This is part of the documentation that should be updated for the CLI. We show also have an example in our documentation too.

There's also another place in the code where this pattern occurs:

{n}-{v}_{t}

Where: n = package name, v = version and t = timestamp.

Source:

conda-build/conda_build/config.py

Line 625 in ccc3e81

pat_dict = {"n": package_name, "v": str(package_version), "t": "{t}"}

[github-actions]

Hi there, thank you for your contribution!

This issue has been automatically marked as stale because it has not had recent activity. It will be closed automatically if no further activity occurs.

If you would like this issue to remain open please:

1. Verify that you can still reproduce the issue at hand
2. Comment that the issue is still reproducible and include:
   - What OS and version you reproduced the issue on
   - What steps you followed to reproduce the issue

NOTE: If this issue was closed prematurely, please leave a comment.

Thanks!