Skip to content

Commit c36f454

Browse files
committed
README: Fix Markdown lints and typos
1 parent 9986a65 commit c36f454

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ Refer to the [`podman push`](http://docs.podman.io/en/latest/markdown/podman-man
3737
<a id="image-tag-inputs"></a>
3838

3939
### Image, Tag and Registry Inputs
40+
4041
The **push-to-registry** `image` and `tag` input work very similarly to [**buildah-build**](https://github.com/redhat-actions/buildah-build#image-tag-inputs).
4142

4243
However, when using **push-to-registry** when the `tags` input are not fully qualified, the `registry` input must also be set.
@@ -46,20 +47,24 @@ So, for **push-to-registry** the options are as follows:
4647
**Option 1**: Provide `registry`, `image`, and `tags` inputs. The image(s) will be pushed to `${registry}/${image}:${tag}`.
4748

4849
For example:
50+
4951
```yaml
5052
registry: quay.io/my-namespace
5153
image: my-image
5254
tags: v1 v1.0.0
5355
```
56+
5457
will push the image tags: `quay.io/my-namespace/my-image:v1` and `quay.io/my-namespace/my-image:v1.0.0`.
5558

5659
**Option 2**: Provide only the `tags` input, including the fully qualified image name in each tag. In this case, the `registry` and `image` inputs are ignored.
5760

5861
For example:
62+
5963
```yaml
6064
# 'registry' and 'image' inputs are not set
6165
tags: quay.io/my-namespace/my-image:v1 quay.io/my-namespace/my-image:v1.0.0
6266
```
67+
6368
will push the image tags: `quay.io/my-namespace/my-image:v1` and `quay.io/my-namespace/my-image:v1.0.0`.
6469

6570
If the `tags` input does not have image names in the `${registry}/${name}:${tag}` form, then the `registry` and `image` inputs must be set.
@@ -68,6 +73,7 @@ If the `tags` input does not have image names in the `${registry}/${name}:${tag}
6873

6974
`digest`: The pushed image digest, as written to the `digestfile`.<br>
7075
For example:
76+
7177
```
7278
sha256:66ce924069ec4181725d15aa27f34afbaf082f434f448dc07a42daa3305cdab3
7379
```
@@ -144,13 +150,15 @@ If the image to push is present in both the Docker and Podman image storage, the
144150
If the action pulled an image from the Docker image storage into the Podman storage, it will be cleaned up from the Podman storage before the action exits.
145151

146152
## Note about GitHub runners and Podman
153+
147154
We recommend using `runs-on: ubuntu-20.04` since it has a newer version of Podman.
148155

149156
If you are on `ubuntu-18.04` or any other older versions of ubuntu your workflow will use an older version of Podman and may encounter issues such as [#26](https://github.com/redhat-actions/push-to-registry/issues/26).
150157

151158
## Troubleshooting
159+
152160
Note that quay.io repositories are private by default.<br>
153161

154162
This means that if you push an image for the first time, you will have to authenticate before pulling it, or go to the repository's settings and change its visibility.
155163

156-
Simiarly, if you receive a 403 Forbidden from GHCR, you may have to update the Package Settings. Refer to [this issue](https://github.com/redhat-actions/push-to-registry/issues/52).
164+
Similarly, if you receive a 403 Forbidden from GHCR, you may have to update the Package Settings. Refer to [this issue](https://github.com/redhat-actions/push-to-registry/issues/52).

0 commit comments

Comments
 (0)