mirror of
https://github.com/elgohr/Publish-Docker-Github-Action.git
synced 2026-03-12 18:07:12 -04:00
Introduce tags. Deprecate tag_names
This commit is contained in:
18
README.md
18
README.md
@@ -130,9 +130,6 @@ Use `buildoptions` when you want to configure [options](https://docs.docker.com/
|
||||
```yaml
|
||||
- name: Publish to Registry
|
||||
uses: elgohr/Publish-Docker-Github-Action@master
|
||||
env:
|
||||
MY_FIRST: variableContent
|
||||
MY_SECOND: variableContent
|
||||
with:
|
||||
name: myDocker/repository
|
||||
username: ${{ secrets.DOCKER_USERNAME }}
|
||||
@@ -140,6 +137,19 @@ Use `buildoptions` when you want to configure [options](https://docs.docker.com/
|
||||
buildoptions: "--compress --force-rm"
|
||||
```
|
||||
|
||||
### tags
|
||||
Use `tags` when you want to bring your own tags (separated by comma).
|
||||
|
||||
```yaml
|
||||
- name: Publish to Registry
|
||||
uses: elgohr/Publish-Docker-Github-Action@master
|
||||
with:
|
||||
name: myDocker/repository
|
||||
username: ${{ secrets.DOCKER_USERNAME }}
|
||||
password: ${{ secrets.DOCKER_PASSWORD }}
|
||||
tags: "latest,another"
|
||||
```
|
||||
|
||||
### cache
|
||||
Use `cache` when you have big images, that you would only like to build partially (changed layers).
|
||||
> CAUTION: Docker builds will cache non-repoducable commands, such as installing packages. If you use this option, your packages will never update. To avoid this, run this action on a schedule with caching **disabled** to rebuild the cache periodically.
|
||||
@@ -167,6 +177,8 @@ jobs:
|
||||
```
|
||||
|
||||
### tag_names
|
||||
> DEPRECATED: Please use tags instead. This option will be removed in a future release.
|
||||
|
||||
Use `tag_names` when you want to push tags/release by their git name (e.g. `refs/tags/MY_TAG_NAME`).
|
||||
> CAUTION: Images produced by this feature can be override by branches with the same name - without a way to restore.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user