diff --git a/README.md b/README.md index 7f968fa4..1ccbcf6d 100644 --- a/README.md +++ b/README.md @@ -231,6 +231,10 @@ jobs: | git_user_email | `[optional]` set the committer git user.email | `false` | `github-action@actions-template-sync.noreply.${SOURCE_REPO_HOSTNAME}` | | git_remote_pull_params |`[optional]` set remote pull parameters | `false` | `--allow-unrelated-histories --squash --strategy=recursive -X theirs` | +### Docker + +There are docker images available. Please checkout [How to use docker](docs/DOCKER.md) for details. + ### Example This repo uses this [template][template] and this action from the [marketplace][marketplace]. diff --git a/docs/DOCKER.md b/docs/DOCKER.md index a122ec44..29b7bf24 100644 --- a/docs/DOCKER.md +++ b/docs/DOCKER.md @@ -1,3 +1,15 @@ # DOCKER ## abstract + +If you want to test things out or if you want to build your own action (e.g. in on prem environments) you are able to use docker images. + +- [github registry][github-repo] +- [dockerhub registry][dockerhub-repo] + +## Use the image + +TODO + +[dockerhub-repo]: https://hub.docker.com/r/andyaugustin/actions-template-sync +[github-repo]: https://github.com/AndreasAugustin/actions-template-sync/pkgs/container/actions-template-sync diff --git a/docs/README.md b/docs/README.md index 752e0419..388074fb 100644 --- a/docs/README.md +++ b/docs/README.md @@ -16,3 +16,4 @@ flowchart LR ``` - [architecture](./ARCHITECTURE.md) +- [how to use the docker images](./DOCKER.md)