diff --git a/images/docker-doc-builder.md b/images/docker-doc-builder.md new file mode 100755 index 000000000..5d0ef8ffd --- /dev/null +++ b/images/docker-doc-builder.md @@ -0,0 +1,25 @@ +# linuxserver/doc-builder + +Expects to run as part of the LSIO CI process. Not for public consumption. + +**Running against remote: ** + + docker run --rm \ + -e CONTAINER_NAME=${CONTAINER_NAME} \ + -v ${TEMPDIR}:/ansible/readme \ + linuxserver/doc-builder:latest + +**Running locally: ** + +If you need to test functionality just navigate to the folder with the readme-vars.yml and run: + + docker run --rm \ + -v $(pwd):/tmp \ + -e LOCAL=true \ + linuxserver/doc-builder:latest + +The output will be in a GENERATED.md in your current working directory. + +The following line is only in this repo for loop testing: + +- { date: "01.01.50:", desc: "I am the release message for this internal repo." }