update inputs; readme

This commit is contained in:
2023-08-18 22:01:39 -07:00
parent 2b8c0ec844
commit 3697f3078d
5 changed files with 94 additions and 28 deletions

View File

@@ -3,7 +3,42 @@ Action for re-tagging an existing docker multi-arch manifest
## Inputs
<!-- -->
### `registry`
URL to the container registry
required: true
### `insecure`
If "true", will use HTTP rather than HTTPS
required: false
### `username`
Username to use to authenticate to the container registry
required: false
### `password`
Password to use to authenticate to the container registry
required: false
### `manifest`
The name/tag of the existing manifest in the registry
required: true
### `tags`
Newline or comma delimited list of new tags to apply to the manifest
required: true
## Example usage
@@ -13,15 +48,21 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Tag the "gitea.example.com/owner/package:latest" image with some new tags
uses: https://gitea.jbrumond.me/actions/docker-tag@v0.1
uses: https://gitea.jbrumond.me/actions/tag-manifest@v0.1
with:
# Container registry where the manifest is hosted
registry: gitea.example.com
# Credentials to access the registry
username: ${{ secrets.REGISTRY_USERNAME }}
password: ${{ secrets.REGISTRY_PASSWORD }}
insecure-registry: false
image: owner/package
old-tag: latest
new-tags: |
# Existing manifest to apply tags to
manifest: owner/package:latest
# New tags to apply (either of these works):
tags: tag1,tag2,tag3
tags: |
tag1
tag2
tag3