Skip to content

Commit 03c347d

Browse files
committed
docs: Use 'publish an image' consistently, instead of 'upload'
1 parent 9f4c3b1 commit 03c347d

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

Sources/containertool/Documentation.docc/containertool.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Wrap a binary in a container image and publish it.
1313
`containertool` can be run directly but its main role is to be a helper tool used by the `ContainerImageBuilder` command plugin. See the plugin documentation for examples of how to use it in this way.
1414

1515
```text
16-
OVERVIEW: Build and upload a container image
16+
OVERVIEW: Build and publish a container image
1717
1818
USAGE: containertool --repository <repository> <executable> [--username <username>] [--password <password>] [--verbose] [--allow-insecure-http <allow-insecure-http>] [--architecture <architecture>] --from <from> [--os <os>] [--tag <tag>]
1919

Sources/containertool/containertool.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ enum AllowHTTP: String, ExpressibleByArgument, CaseIterable { case source, desti
2525
@main struct ContainerTool: AsyncParsableCommand {
2626
static let configuration = CommandConfiguration(
2727
commandName: "containertool",
28-
abstract: "Build and upload a container image"
28+
abstract: "Build and publish a container image"
2929
)
3030

3131
@Option(help: "Default registry for references which do not specify a registry")

Sources/swift-container-plugin/Documentation.docc/build.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Build and package your service
22

3-
Build a container image and upload it to a registry.
3+
Build a container image and publish it to a registry.
44

55
## Overview
66

7-
The plugin exposes the command `build-container-image` which you invoke to build your service, package it in a container image and upload it to a container registry, in a single command:
7+
The plugin exposes the command `build-container-image` which you invoke to build your service, package it in a container image and publish it to a container registry, in a single command:
88

99
```shell
1010
% swift package --swift-sdk x86_64-swift-linux-musl \
@@ -13,7 +13,7 @@ The plugin exposes the command `build-container-image` which you invoke to build
1313

1414
* The `--swift-sdk` argument specifies the Swift SDK with which to build the executable. In this case we are using the Static Linux SDK, [installed earlier](<doc:requirements>), to build an statically-linked x86_64 Linux executable.
1515
* The `--from` argument specifies the base image on which our service will run. `swift:slim` is the default, but you can choose your own base image or use `scratch` if your service does not require a base image at all.
16-
* The `--repository` argument specifies the repository to which the plugin will upload the finished image.
16+
* The `--repository` argument specifies the repository to which the plugin will publish the finished image.
1717

1818
> Note: on macOS, the plugin needs permission to connect to the network to publish the image to the registry.
1919
>
@@ -46,15 +46,15 @@ Any standard container runtime can use the reference to pull and run your servic
4646
4747
### Default registry
4848
49-
If you don't include a registry name in the `--repository` argument, the plugin will upload your image to Docker Hub by default.
49+
If you don't include a registry name in the `--repository` argument, the plugin will publish your image to Docker Hub by default.
5050
5151
You can override the default registry by using the `--default-registry` argument or setting the `CONTAINERTOOL_DEFAULT_REGISTRY` environment variable.
5252
53-
The following examples show how to upload images to some popular registry providers.
53+
The following examples show how to publish images to some popular registry providers.
5454
5555
### Docker Hub
5656
57-
The following example uploads an image to a repository named `mydockerid/example` on Docker Hub.
57+
The following example publishes an image to a repository named `mydockerid/example` on Docker Hub.
5858
5959
The repository will be created if it does not already exist.
6060
@@ -65,7 +65,7 @@ swift package --swift-sdk x86_64-swift-linux-musl build-container-image \
6565
6666
### GitHub Container Registry
6767
68-
The following example uploads an image to a repository named `mydockerid/example` on GitHub Container Registry.
68+
The following example publishes an image to a repository named `mydockerid/example` on GitHub Container Registry.
6969
7070
The repository will be created if it does not already exist.
7171
@@ -76,7 +76,7 @@ swift package --swift-sdk x86_64-swift-linux-musl build-container-image \
7676
7777
### Amazon Elastic Container Registry
7878
79-
The following example uploads an image to the repository named `example/test` on Amazon Elastic Container Registry.
79+
The following example publishes an image to the repository named `example/test` on Amazon Elastic Container Registry.
8080
8181
**The repository must already exist before you push to it.**
8282
Create a repository using the [Amazon ECR Console](https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-create.html).

0 commit comments

Comments
 (0)