Skip to content

Commit

Permalink
Update docs for Image (#840)
Browse files Browse the repository at this point in the history
Updates the docs with a note that says local repoDigest is now
supported.

See
[comment](#739 (comment))

I'd like to get this in because due to #828 being merged we are ready to
cut a patch release, which will ensure that the update appears in the
registry.
  • Loading branch information
guineveresaenger authored Nov 13, 2023
1 parent 7284bef commit 2641aad
Show file tree
Hide file tree
Showing 10 changed files with 15 additions and 22 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ install_nodejs_sdk:
yarn link --cwd $(WORKING_DIR)/sdk/nodejs/bin

install_plugins: .pulumi/bin/pulumi
.pulumi/bin/pulumi plugin install resource aws 5.37.0
.pulumi/bin/pulumi plugin install resource aws 6.8.0

lint_provider: provider
cd provider && golangci-lint run -c ../.golangci.yml
Expand Down
2 changes: 1 addition & 1 deletion provider/cmd/pulumi-resource-docker/schema.json

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions provider/pkg/docs-gen/examples/image.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ outputs:
resources:
demo-image:
options:
version: v4.0.0
version: v4.4.0
properties:
build:
args:
Expand Down Expand Up @@ -246,7 +246,7 @@ outputs:
resources:
demo-push-image:
options:
version: v4.0.0
version: v4.4.0
properties:
build:
context: .
Expand Down Expand Up @@ -406,7 +406,7 @@ package main
import (
"fmt"

"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/ecr"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ecr"
"github.com/pulumi/pulumi-docker/sdk/v4/go/docker"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
Expand Down
4 changes: 2 additions & 2 deletions provider/pkg/docs-gen/examples/yaml/image.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ resources:
args:
platform: linux/amd64
options:
version: v4.0.0
version: v4.4.0
outputs:
imageName: ${demo-image.imageName}
---
Expand All @@ -33,7 +33,7 @@ resources:
dockerfile: Dockerfile
context: .
options:
version: v4.0.0
version: v4.4.0
outputs:
imageName: ${demo-push-image.imageName}
repoDigest: ${demo-push-image.repoDigest}
Expand Down
3 changes: 1 addition & 2 deletions provider/pkg/docs-gen/image-description.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ Note that this does not include any digest information and thus will not cause a
even when using `latest` tag. To trigger such updates, e.g. when referencing pushed images in container orchestration
and management resources, please use the `repoDigest` Output instead, which is of the format
`repository@<algorithm>:<hash>` and unique per build/push.
Note that `repoDigest` is not available for local Images. For a local Image not pushed to a registry, you may want to
give `imageName` a unique tag per pulumi update.
As of Docker v4.4, `repoDigest` is now available for local Images.

## Cross-platform builds

Expand Down
3 changes: 1 addition & 2 deletions sdk/dotnet/Image.cs
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@ namespace Pulumi.Docker
/// even when using `latest` tag. To trigger such updates, e.g. when referencing pushed images in container orchestration
/// and management resources, please use the `repoDigest` Output instead, which is of the format
/// `repository@&lt;algorithm&gt;:&lt;hash&gt;` and unique per build/push.
/// Note that `repoDigest` is not available for local Images. For a local Image not pushed to a registry, you may want to
/// give `imageName` a unique tag per pulumi update.
/// As of Docker v4.4, `repoDigest` is now available for local Images.
///
/// ## Cross-platform builds
///
Expand Down
5 changes: 2 additions & 3 deletions sdk/go/docker/image.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 1 addition & 2 deletions sdk/java/src/main/java/com/pulumi/docker/Image.java
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,7 @@
* even when using `latest` tag. To trigger such updates, e.g. when referencing pushed images in container orchestration
* and management resources, please use the `repoDigest` Output instead, which is of the format
* `repository@&lt;algorithm&gt;:&lt;hash&gt;` and unique per build/push.
* Note that `repoDigest` is not available for local Images. For a local Image not pushed to a registry, you may want to
* give `imageName` a unique tag per pulumi update.
* As of Docker v4.4, `repoDigest` is now available for local Images.
*
* ## Cross-platform builds
*
Expand Down
3 changes: 1 addition & 2 deletions sdk/nodejs/image.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,7 @@ import * as utilities from "./utilities";
* even when using `latest` tag. To trigger such updates, e.g. when referencing pushed images in container orchestration
* and management resources, please use the `repoDigest` Output instead, which is of the format
* `repository@<algorithm>:<hash>` and unique per build/push.
* Note that `repoDigest` is not available for local Images. For a local Image not pushed to a registry, you may want to
* give `imageName` a unique tag per pulumi update.
* As of Docker v4.4, `repoDigest` is now available for local Images.
*
* ## Cross-platform builds
*
Expand Down
6 changes: 2 additions & 4 deletions sdk/python/pulumi_docker/image.py
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,7 @@ def __init__(__self__,
even when using `latest` tag. To trigger such updates, e.g. when referencing pushed images in container orchestration
and management resources, please use the `repoDigest` Output instead, which is of the format
`repository@<algorithm>:<hash>` and unique per build/push.
Note that `repoDigest` is not available for local Images. For a local Image not pushed to a registry, you may want to
give `imageName` a unique tag per pulumi update.
As of Docker v4.4, `repoDigest` is now available for local Images.
## Cross-platform builds
Expand Down Expand Up @@ -212,8 +211,7 @@ def __init__(__self__,
even when using `latest` tag. To trigger such updates, e.g. when referencing pushed images in container orchestration
and management resources, please use the `repoDigest` Output instead, which is of the format
`repository@<algorithm>:<hash>` and unique per build/push.
Note that `repoDigest` is not available for local Images. For a local Image not pushed to a registry, you may want to
give `imageName` a unique tag per pulumi update.
As of Docker v4.4, `repoDigest` is now available for local Images.
## Cross-platform builds
Expand Down

0 comments on commit 2641aad

Please sign in to comment.