Skip to content

Add documentation for ContainerImageFormat Container Publishing flag #45908

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Apr 23, 2025
+16 −1
Merged

Add documentation for ContainerImageFormat Container Publishing flag #45908

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9291740
Add documentation for `ContainerImageFormat` Container Publishing flag
CamSoper Apr 23, 2025
5faf648
feedback
CamSoper Apr 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion docs/core/containers/publish-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,22 @@ The container repository is the name of the image itself, for example, `dotnet/r

Image names consist of one or more slash-delimited segments, each of which can only contain lowercase alphanumeric characters, periods, underscores, and dashes, and must start with a letter or number. Any other characters result in an error being thrown.

### `ContainerImageTag(s)`
### `ContainerImageFormat`

Starting with .NET 8.0.405, you can use the `ContainerImageFormat` MSBuild property to specify the image format as either `Docker` or `OCI`. By default, the .NET tooling infers the format from the base image. For example, .NET base images use the Docker-specific format `application/vnd.docker.distribution.manifest.v2+json`. However, many modern tools prefer the OCI format `application/vnd.oci.image.manifest.v1+json`. To force a specific format, set the property as shown:

```xml
<PropertyGroup>
<ContainerImageFormat>OCI</ContainerImageFormat>
</PropertyGroup>
```

Both formats are largely interchangeable without loss of information.

> [!NOTE]
> When building a multi-architecture image, the resulting image format is always OCI.

### `ContainerImageTag`

The container image tag property controls the tags that are generated for the image. To specify a single tag use `ContainerImageTag` and for multiple tags use `ContainerImageTags`.

Expand Down