Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate extraOptions and env #468

Merged
merged 7 commits into from
Jan 27, 2023
Merged

Deprecate extraOptions and env #468

merged 7 commits into from
Jan 27, 2023

Conversation

guineveresaenger
Copy link
Contributor

@guineveresaenger guineveresaenger commented Jan 27, 2023

This PR cleans up:

env - it was used to pass CLI environment variables like BUILDKIT=1 and we now have builderVersion instead

extraOptions - we cannot support a grab bag of command line options when using the docker SDK.

  • Remove env from schema
  • Remove handling of deprecated env field from Image implementation
  • Generate SDKs for removal of env type
  • Remove extraOptions field
  • Remove extraOptions implementation and tests
  • Regenerate SDKs

Fixes #469

The `env` field was used to pass along a buildkit option.
This functionality has been replaced by `builderVersion`.
Additionally, an `ENV` field is common to use in Dockerfiles, and to
pass to containers as runtime flags, so using this name is confusing as
well. ENV vars do not get passed at build time.
This field was used to pass arbitrary values to the invocation of the
Docker CLI. Using the go docker SDK, we will over time add these as
fully typed features.
@github-actions
Copy link

Does the PR have any schema changes?

Found 2 breaking changes:
Type "docker:index/dockerBuild:DockerBuild" missing property "extraOptions"
Type "docker:index/dockerBuild:DockerBuild" missing property "env"
No new resources/functions.

@github-actions
Copy link

Does the PR have any schema changes?

Found 2 breaking changes:
Type "docker:index/dockerBuild:DockerBuild" missing property "env"
Type "docker:index/dockerBuild:DockerBuild" missing property "extraOptions"
No new resources/functions.

@guineveresaenger guineveresaenger merged commit dbec7b6 into master Jan 27, 2023
@guineveresaenger guineveresaenger deleted the deprecations branch January 27, 2023 21:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clean up env and extraOptions types
2 participants