Skip to content

Comments

image/specs: add missing OnBuild (v1.0), ArgsEscaped (v1.1), and Shell (v1.2) fields#46371

Merged
thaJeztah merged 3 commits intomoby:masterfrom
thaJeztah:image_specs_amend
Aug 30, 2023
Merged

image/specs: add missing OnBuild (v1.0), ArgsEscaped (v1.1), and Shell (v1.2) fields#46371
thaJeztah merged 3 commits intomoby:masterfrom
thaJeztah:image_specs_amend

Conversation

@thaJeztah
Copy link
Member

@thaJeztah thaJeztah commented Aug 30, 2023

relates to:

image/spec: add missing "OnBuild" field

This field was added in commit 9f994c9,
which was merged before the image-spec v1.0.0 was released (which happened
in commit 7991062).

This patch back-fills the specifications to describe the property.

image/spec: add missing "ArgsEscaped" field (v1.1, v1.2)

This field was added in 9db5db1, which
was part of v1.10.0-rc1 and later, which used image spec v1.1.0.

It's worth noting that documentation for the v1.1.0 image spec was not
yet available until commit 4fa0ecc,
which was included in v1.12.0-rc1 and up. The ArgsEscaped field was
also adopted by the OCI image spec since v1.1.0-rc3, but considered
deprecated, and not recommended to be used.

This patch amends the v1.1 and v1.2 specifications to describe the field.

image/spec: add missing "Shell" field (v1.2)

This field was added in b18ae8c, which
was part of v1.12.0-rc1 and later, which used image spec v1.2.0.

This patch amends the v1.2 spec to include the missing field.

- A picture of a cute animal (not mandatory but encouraged)

This field was added in commit 9f994c9,
which was merged before the image-spec v1.0.0 was released (which happened
in commit 7991062).

This patch backfills the specifications to describe the property.

Signed-off-by: Sebastiaan van Stijn <[email protected]>
This field was added in 9db5db1, which
was part of v1.10.0-rc1 and later, which used image spec v1.1.0.

It's worth noting that documentation for the v1.1.0 image spec was not
yet available until commit 4fa0ecc,
which was included in v1.12.0-rc1 and up. The `ArgsEscaped` field was
also adopted by the OCI image spec since [v1.1.0-rc3][1], but considered
deprecated, and not recommended to be used.

This patch amends the v1.1 and v1.2 specifications to describe the field.

[1]: opencontainers/image-spec@59780aa

Signed-off-by: Sebastiaan van Stijn <[email protected]>
@thaJeztah
Copy link
Member Author

Oh! Let me double-check if the fields are in the right spot, and that they're in the image config, not the container config

@thaJeztah
Copy link
Member Author

Oh, hm.. ContainerConfig is not part of the spec, so I guess we’re good

This field was added in b18ae8c, which
was part of v1.12.0-rc1 and later, which used image spec v1.2.0.

This patch amends the v1.2 spec to include the missing field.

Signed-off-by: Sebastiaan van Stijn <[email protected]>
@thaJeztah thaJeztah changed the title image/specs: add missing OnBuild (v1.0) and ArgsEscaped (v1.1) fields image/specs: add missing OnBuild (v1.0), ArgsEscaped (v1.1), and Shell (v1.2) fields Aug 30, 2023
@thaJeztah
Copy link
Member Author

Pushed a commit to also document Shell

@thaJeztah thaJeztah merged commit daa4618 into moby:master Aug 30, 2023
@thaJeztah thaJeztah deleted the image_specs_amend branch August 30, 2023 13:54
@thaJeztah thaJeztah added this to the 25.0.0 milestone Oct 26, 2023
@thaJeztah thaJeztah mentioned this pull request Oct 15, 2024
79 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants