Skip to content

Commit 3a07d44

Browse files
authored
update docs to have working oras examples (devcontainers#324)
The push and pull examples do not work with the current cli. The latest oras documentation describes the use of the `--config` option for the [push](https://oras.land/docs/commands/oras_push) and [pull](https://oras.land/docs/commands/oras_pull) commands. This parameter change (rename the `--manifest-config` to `--config`) was [documented as a breaking change](https://github.com/oras-project/oras/releases/tag/v0.14.0) in version 0.14.0 of the ORAS CLI, which was released in August 2022.
1 parent 7b82fdd commit 3a07d44

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

_implementors/features-distribution.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ ARTIFACT_PATH=devcontainer-feature-go.tgz
116116
for VERSION in 1 1.2 1.2.3 latest
117117
do
118118
oras push ${REGISTRY}/${NAMESPACE}/${FEATURE}:${VERSION} \
119-
--manifest-config /dev/null:application/vnd.devcontainers \
119+
--config /dev/null:application/vnd.devcontainers \
120120
./${ARTIFACT_PATH}:application/vnd.devcontainers.layer.v1+tar
121121
done
122122
```
@@ -131,7 +131,7 @@ REGISTRY=ghcr.io
131131
NAMESPACE=devcontainers/features
132132

133133
oras push ${REGISTRY}/${NAMESPACE}:latest \
134-
--manifest-config /dev/null:application/vnd.devcontainers \
134+
--config /dev/null:application/vnd.devcontainers \
135135
./devcontainer-collection.json:application/vnd.devcontainers.collection.layer.v1+json
136136
```
137137

_implementors/templates-distribution.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ ARTIFACT_PATH=devcontainer-template-go.tgz
113113
for VERSION in 1 1.2 1.2.3 latest
114114
do
115115
oras push ${REGISTRY}/${NAMESPACE}/${TEMPLATE}:${VERSION} \
116-
--manifest-config /dev/null:application/vnd.devcontainers \
116+
--config /dev/null:application/vnd.devcontainers \
117117
./${ARTIFACT_PATH}:application/vnd.devcontainers.layer.v1+tar
118118
done
119119

@@ -129,7 +129,7 @@ REGISTRY=ghcr.io
129129
NAMESPACE=devcontainers/templates
130130

131131
oras push ${REGISTRY}/${NAMESPACE}:latest \
132-
--manifest-config /dev/null:application/vnd.devcontainers \
132+
--config /dev/null:application/vnd.devcontainers \
133133
./devcontainer-collection.json:application/vnd.devcontainers.collection.layer.v1+json
134134
```
135135

0 commit comments

Comments
 (0)