actions/dockerhub-description
actions/dockerhub-description
3
0
Fork 0
mirror of https://github.com/peter-evans/dockerhub-description.git synced 2024-11-25 13:39:33 +01:00
Code Issues Projects Activity Pipelines

Update README examples

Browse source
This commit is contained in:
Peter Evans 2019-06-25 21:10:05 +09:00
parent 5f19c66987
commit ef7baa2fee
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -8,7 +8,7 @@ This is useful if you `docker push` your images to Docker Hub. It provides an ea
## Usage ## Usage
``` ```
action "Update Docker Hub Repository Description" { action "Docker Hub Description" {
uses = "peter-evans/dockerhub-description@v1.0.0" uses = "peter-evans/dockerhub-description@v1.0.0"
secrets = ["DOCKERHUB_USERNAME", "DOCKERHUB_PASSWORD", "DOCKERHUB_REPOSITORY"] secrets = ["DOCKERHUB_USERNAME", "DOCKERHUB_PASSWORD", "DOCKERHUB_REPOSITORY"]
} }
@ -26,7 +26,7 @@ The action assumes that there is a file called `README.md` located at the root o
If this is not the case, the path can be overridden with an environment variable. If this is not the case, the path can be overridden with an environment variable.
``` ```
action "Update Docker Hub Repository Description" { action "Docker Hub Description" {
uses = "peter-evans/dockerhub-description@v1.0.0" uses = "peter-evans/dockerhub-description@v1.0.0"
secrets = ["DOCKERHUB_USERNAME", "DOCKERHUB_PASSWORD", "DOCKERHUB_REPOSITORY"] secrets = ["DOCKERHUB_USERNAME", "DOCKERHUB_PASSWORD", "DOCKERHUB_REPOSITORY"]
env = { env = {
@ -39,9 +39,9 @@ action "Update Docker Hub Repository Description" {
Updates the Docker Hub repository description whenever there is a `git push` to the `master` branch. Updates the Docker Hub repository description whenever there is a `git push` to the `master` branch.
``` ```
workflow "New workflow" { workflow "Update Docker Hub Description" {
resolves = ["Docker Hub Description"]
on = "push" on = "push"
resolves = ["Update Docker Hub Repository Description"]
} }
action "Filter master branch" { action "Filter master branch" {
@ -49,7 +49,7 @@ action "Filter master branch" {
args = "branch master" args = "branch master"
} }
action "Update Docker Hub Repository Description" { action "Docker Hub Description" {
needs = ["Filter master branch"] needs = ["Filter master branch"]
uses = "peter-evans/dockerhub-description@v1.0.0" uses = "peter-evans/dockerhub-description@v1.0.0"
secrets = ["DOCKERHUB_USERNAME", "DOCKERHUB_PASSWORD", "DOCKERHUB_REPOSITORY"] secrets = ["DOCKERHUB_USERNAME", "DOCKERHUB_PASSWORD", "DOCKERHUB_REPOSITORY"]
@ -58,12 +58,12 @@ action "Update Docker Hub Repository Description" {
Updates the Docker Hub repository description whenever a new release is created. Updates the Docker Hub repository description whenever a new release is created.
``` ```
workflow "New workflow" { workflow "Update Docker Hub Description" {
resolves = ["Docker Hub Description"]
on = "release" on = "release"
resolves = ["Update Docker Hub Repository Description"]
} }
action "Update Docker Hub Repository Description" { action "Docker Hub Description" {
uses = "peter-evans/dockerhub-description@v1.0.0" uses = "peter-evans/dockerhub-description@v1.0.0"
secrets = ["DOCKERHUB_USERNAME", "DOCKERHUB_PASSWORD", "DOCKERHUB_REPOSITORY"] secrets = ["DOCKERHUB_USERNAME", "DOCKERHUB_PASSWORD", "DOCKERHUB_REPOSITORY"]
} }