diff --git a/README.md b/README.md index 80e8474..2b4d71e 100644 --- a/README.md +++ b/README.md @@ -1 +1,73 @@ -# dockerhub-description \ No newline at end of file +# Docker Hub Description + +A GitHub action to update a Docker Hub repository description from `README.md`. + +This is useful if you `docker push` your images to Docker Hub. It provides an easy, automated way to keep your Docker Hub repository description in sync with your GitHub repository `README.md` file. + +## Usage + +``` +action "Update Docker Hub Repository Description" { + uses = "peter-evans/dockerhub-description@1.0" + secrets = ["DOCKERHUB_USERNAME", "DOCKERHUB_PASSWORD", "DOCKERHUB_REPOSITORY"] +} +``` + +#### Required secrets + +- `DOCKERHUB_USERNAME` - Docker Hub username +- `DOCKERHUB_PASSWORD` - Docker Hub password +- `DOCKERHUB_REPOSITORY` - The name of the Docker Hub repository to update. (This may also be an environment variable if not considered sensitive) + +#### Optionally specifying the file path + +The action assumes that there is a file called `README.md` located at the root of the repository. +If this is not the case, the path can be overridden with an environment variable. + +``` +action "Update Docker Hub Repository Description" { + uses = "peter-evans/dockerhub-description@1.0" + secrets = ["DOCKERHUB_USERNAME", "DOCKERHUB_PASSWORD", "DOCKERHUB_REPOSITORY"] + env = { + README_FILEPATH = "./some-path/README.md" + } +} +``` + +#### Examples + +Updates the Docker Hub repository description whenever there is a `git push` to the `master` branch. +``` +workflow "New workflow" { + on = "push" + resolves = ["Update Docker Hub Repository Description"] +} + +action "Filter master branch" { + uses = "actions/bin/filter@master" + args = "branch master" +} + +action "Update Docker Hub Repository Description" { + needs = ["Filter master branch"] + uses = "peter-evans/dockerhub-description@1.0" + secrets = ["DOCKERHUB_USERNAME", "DOCKERHUB_PASSWORD", "DOCKERHUB_REPOSITORY"] +} +``` + +Updates the Docker Hub repository description whenever a new release is created. +``` +workflow "New workflow" { + on = "release" + resolves = ["Update Docker Hub Repository Description"] +} + +action "Update Docker Hub Repository Description" { + uses = "peter-evans/dockerhub-description@1.0" + secrets = ["DOCKERHUB_USERNAME", "DOCKERHUB_PASSWORD", "DOCKERHUB_REPOSITORY"] +} +``` + +## License + +MIT License - see the [LICENSE](LICENSE) file for details