Specify default output directory

opendevstack · Oct 24, 2023 · 2199e0a · 2199e0a
1 parent 38cad22
commit 2199e0a
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 3 deletions.
diff --git a/build/docs/render.adoc b/build/docs/render.adoc
@@ -10,4 +10,4 @@ The asciidoc template can access the value of the field `a` by referencing `{{.a
 
 Note that only JSON and YAML formats are recognized. If a matching file does not end in either `.json` or `.y(a)ml`, its entire content is made available under the key `value`. For example, the glob pattern `log:*.log` might match the file `pipeline-run.log`, which would expose the content of the file as `log.root.pipeline_run.value` to the template.
 
-After the Go template has been rendered, link:https://github.com/asciidoctor/asciidoctor-pdf[asciidoctor-pdf] is used to turn each rendered asciidoc file into a PDF file. The resulting files are placed into the directory specified by `output-dir`. Theming is possible by specifying the `pdf-theme` parameter as explained in the link:https://docs.asciidoctor.org/pdf-converter/latest/theme/apply-theme/#theme-and-font-directories[Theme and font directories] documentation.
+After the Go template has been rendered, link:https://github.com/asciidoctor/asciidoctor-pdf[asciidoctor-pdf] is used to turn each rendered asciidoc file into a PDF file. The resulting files are placed into the directory specified by `output-dir` (defaulting to `.ods/artifacts/org.opendevstack.pipeline.adoc.pdf` so that created PDFs are preserved as artifacts in Nexus). Theming is possible by specifying the `pdf-theme` parameter as explained in the link:https://docs.asciidoctor.org/pdf-converter/latest/theme/apply-theme/#theme-and-font-directories[Theme and font directories] documentation.
diff --git a/build/tasks/render.yaml b/build/tasks/render.yaml
@@ -22,6 +22,7 @@ spec:
       description: >-
         Output directory where to place the rendered PDF files.
       type: string
+      default: ".ods/artifacts/org.opendevstack.pipeline.adoc.pdf"
     - name: data-sources
       description: >-
         Glob patterns from where to source data.

diff --git a/docs/render.adoc b/docs/render.adoc
@@ -14,7 +14,7 @@ The asciidoc template can access the value of the field `a` by referencing `{{.a
 
 Note that only JSON and YAML formats are recognized. If a matching file does not end in either `.json` or `.y(a)ml`, its entire content is made available under the key `value`. For example, the glob pattern `log:*.log` might match the file `pipeline-run.log`, which would expose the content of the file as `log.root.pipeline_run.value` to the template.
 
-After the Go template has been rendered, link:https://github.com/asciidoctor/asciidoctor-pdf[asciidoctor-pdf] is used to turn each rendered asciidoc file into a PDF file. The resulting files are placed into the directory specified by `output-dir`. Theming is possible by specifying the `pdf-theme` parameter as explained in the link:https://docs.asciidoctor.org/pdf-converter/latest/theme/apply-theme/#theme-and-font-directories[Theme and font directories] documentation.
+After the Go template has been rendered, link:https://github.com/asciidoctor/asciidoctor-pdf[asciidoctor-pdf] is used to turn each rendered asciidoc file into a PDF file. The resulting files are placed into the directory specified by `output-dir` (defaulting to `.ods/artifacts/org.opendevstack.pipeline.adoc.pdf` so that created PDFs are preserved as artifacts in Nexus). Theming is possible by specifying the `pdf-theme` parameter as explained in the link:https://docs.asciidoctor.org/pdf-converter/latest/theme/apply-theme/#theme-and-font-directories[Theme and font directories] documentation.
 
 
 == Parameters
@@ -36,7 +36,7 @@ without leading `./` and trailing `/`.
 
 
 | output-dir
-| 
+| .ods/artifacts/org.opendevstack.pipeline.adoc.pdf
 | Output directory where to place the rendered PDF files.
 
 

diff --git a/tasks/render.yaml b/tasks/render.yaml
@@ -24,6 +24,7 @@ spec:
       description: >-
         Output directory where to place the rendered PDF files.
       type: string
+      default: ".ods/artifacts/org.opendevstack.pipeline.adoc.pdf"
     - name: data-sources
       description: >-
         Glob patterns from where to source data.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -10,4 +10,4 @@ The asciidoc template can access the value of the field `a` by referencing `{{.a

		Note that only JSON and YAML formats are recognized. If a matching file does not end in either `.json` or `.y(a)ml`, its entire content is made available under the key `value`. For example, the glob pattern `log:*.log` might match the file `pipeline-run.log`, which would expose the content of the file as `log.root.pipeline_run.value` to the template.

		After the Go template has been rendered, link:https://github.com/asciidoctor/asciidoctor-pdf[asciidoctor-pdf] is used to turn each rendered asciidoc file into a PDF file. The resulting files are placed into the directory specified by `output-dir`. Theming is possible by specifying the `pdf-theme` parameter as explained in the link:https://docs.asciidoctor.org/pdf-converter/latest/theme/apply-theme/#theme-and-font-directories[Theme and font directories] documentation.
		After the Go template has been rendered, link:https://github.com/asciidoctor/asciidoctor-pdf[asciidoctor-pdf] is used to turn each rendered asciidoc file into a PDF file. The resulting files are placed into the directory specified by `output-dir` (defaulting to `.ods/artifacts/org.opendevstack.pipeline.adoc.pdf` so that created PDFs are preserved as artifacts in Nexus). Theming is possible by specifying the `pdf-theme` parameter as explained in the link:https://docs.asciidoctor.org/pdf-converter/latest/theme/apply-theme/#theme-and-font-directories[Theme and font directories] documentation.