Move environment option into build stanza and document it#2807
Open
Move environment option into build stanza and document it#2807
Conversation
The environment cog.yaml option is a build-time setting that adds environment variables to the Docker image, so it belongs in the build stanza rather than at the top level. - Move Environment field from Config to Build struct - Accept top-level environment with a deprecation warning for backward compatibility; error if set in both places - Add environment to the JSON schema under build properties - Add documentation to docs/yaml.md - Update integration test and YAML overwrite test fixtures - Regenerate docs/llms.txt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
environmentcog.yaml option from the top level into thebuild:stanza, since it's a build-time setting that adds env vars to the Docker imageenvironmentindocs/yaml.mdenvironmentstill works but emits a deprecation warningChanges
Config structs:
EnvironmentandparsedEnvironmentmoved fromConfigtoBuild. The canonical location is nowbuild.environment.Backward compatibility: A new
resolveEnvironment()validation step handles migration:build.environmentwith a deprecation warningbuild.environmentonly → no-opJSON schema:
environmentadded tobuildproperties; top-level kept with deprecation note.Documentation: New
### environmentsection under## buildindocs/yaml.md(alphabetically betweencudaandgpu). Documents theNAME=valueformat, provides an example, and notes reserved variable names.Tests: Integration test and YAML overwrite test fixtures updated to use the new location.
Example