From ab53d512bd3dcb6a007a8aa546cb62f3d2cf428a Mon Sep 17 00:00:00 2001 From: GitHub Actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 6 Apr 2022 00:02:04 +0000 Subject: [PATCH 1/4] chore: changed lines [1] of file "/tmp/updatecli/asciidoctor/docker-asc... MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ... iidoctor/Dockerfile" Made with ❤️️ by updatecli --- Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Dockerfile b/Dockerfile index b0fd3291..5ee28ea2 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,4 +1,4 @@ -ARG alpine_version=3.15.3 +ARG alpine_version=3.15.4 FROM alpine:${alpine_version} AS base ARG asciidoctor_version=2.0.17 From f8d9e1b79a73742d9bc017f9a47c4e399a1ca06a Mon Sep 17 00:00:00 2001 From: GitHub Actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 6 Apr 2022 00:02:05 +0000 Subject: [PATCH 2/4] chore: changed lines [1] of file "/tmp/updatecli/asciidoctor/docker-asc... MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ... iidoctor/Dockerfile" Made with ❤️️ by updatecli --- README.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.adoc b/README.adoc index 001ca8f0..27e8079d 100644 --- a/README.adoc +++ b/README.adoc @@ -1,4 +1,4 @@ -:ALPINE_VERSION: 3.15.3 +:ALPINE_VERSION: 3.15.4 :ASCIIDOCTOR_VERSION: 2.0.17 :ASCIIDOCTOR_CONFLUENCE_VERSION: 0.0.2 :ASCIIDOCTOR_PDF_VERSION: 1.6.2 From f4c3b6b74387fb4b50bf51b0436a3c3058bf1275 Mon Sep 17 00:00:00 2001 From: GitHub Actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 6 Apr 2022 00:02:06 +0000 Subject: [PATCH 3/4] chore: changed lines [1] of file "/tmp/updatecli/asciidoctor/docker-asc... MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ... iidoctor/Dockerfile" Made with ❤️️ by updatecli --- tests/asciidoctor.bats | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/asciidoctor.bats b/tests/asciidoctor.bats index e34af657..4eea4935 100644 --- a/tests/asciidoctor.bats +++ b/tests/asciidoctor.bats @@ -1,7 +1,7 @@ #!/usr/bin/env bats TMP_GENERATION_DIR="${BATS_TEST_DIRNAME}/tmp" -ALPINE_VERSION=3.15.3 +ALPINE_VERSION=3.15.4 ASCIIDOCTOR_VERSION=2.0.17 ASCIIDOCTOR_CONFLUENCE_VERSION=0.0.2 ASCIIDOCTOR_PDF_VERSION=1.6.2 From fc125894d329871a9735e5d9aabfd7bcf8881d55 Mon Sep 17 00:00:00 2001 From: "asciidoctor-updateclibot[bot]" Date: Wed, 6 Apr 2022 00:15:33 +0000 Subject: [PATCH 4/4] Updating README files using 'make README command' Signed-off-by: asciidoctor-updateclibot[bot] --- README.md | 46 ++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 42 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4e12148e..c8cb9736 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,11 @@ This Docker image provides: -- [Asciidoctor](https://asciidoctor.org/) 2.0.16 +- [Asciidoctor](https://asciidoctor.org/) 2.0.17 - [Asciidoctor Diagram](https://asciidoctor.org/docs/asciidoctor-diagram/) 2.2.1 with ERD and Graphviz integration (supports plantuml and graphiz diagrams) -- [Asciidoctor PDF](https://asciidoctor.org/docs/asciidoctor-pdf/) 1.6.1 +- [Asciidoctor PDF](https://asciidoctor.org/docs/asciidoctor-pdf/) 1.6.2 - [Asciidoctor EPUB3](https://asciidoctor.org/docs/asciidoctor-epub3/) 1.5.1 @@ -28,7 +28,13 @@ This Docker image provides: - [Asciidoctor Kroki](https://github.com/Mogztter/asciidoctor-kroki) 0.5.0 -This image uses Alpine Linux 3.13.5 as base image. +This image uses Alpine Linux 3.15.4 as base image. + +
+ +Docker Engine [20.10](https://docs.docker.com/engine/release-notes/#20100) or later is required (or any container engine supporting [Alpine 3.14](https://wiki.alpinelinux.org/wiki/Release_Notes_for_Alpine_3.14.0)) to avoid unexpected `No such file or directory` errors (such as [\#214](https://github.com/asciidoctor/docker-asciidoctor/issues/214) or [\#215](https://github.com/asciidoctor/docker-asciidoctor/issues/215)). + +
## How to use it @@ -36,7 +42,17 @@ Just run: docker run -it -v :/documents/ asciidoctor/docker-asciidoctor -Docker maps your directory with */documents* directory in the container. +or the following for [Podman](https://podman.io/): + + podman run -it -v :/documents/ docker.io/asciidoctor/docker-asciidoctor + +Docker/Podman maps your directory with */documents* directory in the container. + +
+ +You might need to add the option `:z` or `:Z` like `:/documents/:z` or `:/documents/:Z` if you are using SELinux. See [Docker docs](https://docs.docker.com/storage/bind-mounts/#configure-the-selinux-label) or [Podman docs](https://docs.podman.io/en/latest/markdown/podman-run.1.html#volume-v-source-volume-host-dir-container-dir-options). + +
After you start the container, you can use Asciidoctor commands to convert AsciiDoc files that you created in the directory mentioned above. You can find several examples below. @@ -53,6 +69,12 @@ You can find several examples below. asciidoctor-pdf -r asciidoctor-diagram sample-with-diagram.adoc asciidoctor-epub3 -r asciidoctor-diagram sample-with-diagram.adoc +- To run AsciiDoc on an AsciiDoc file that contains latexmath and stem blocks: + + asciidoctor -r asciidoctor-mathematical sample-with-diagram.adoc + asciidoctor-pdf -r asciidoctor-mathematical sample-with-diagram.adoc + asciidoctor-epub3 -r asciidoctor-mathematical sample-with-diagram.adoc + - To use Asciidoctor Confluence: asciidoctor-confluence --host HOSTNAME --spaceKey SPACEKEY --title TITLE --username USER --password PASSWORD sample.adoc @@ -71,6 +93,10 @@ You can find several examples below. docker run --rm -v $(pwd):/documents/ asciidoctor/docker-asciidoctor asciidoctor-pdf index.adoc + or: + + podman run --rm -v $(pwd):/documents/ docker.io/asciidoctor/docker-asciidoctor asciidoctor-pdf index.adoc + ## How to contribute / do it yourself? ### Requirements @@ -85,6 +111,8 @@ You need the following tools: - Docker installed and in your path +- [Trivy](https://github.com/aquasecurity/trivy) cli in case you want to scan images for vulnerabilities + ### How to build and test? - Bats is used as a test suite runner. Since the ability to build is one way of testing, it is included. @@ -102,6 +130,16 @@ Optionally, you can specify a custom image name: export DOCKER_IMAGE_NAME_TO_TEST=your-image-name bats tests/*.bats +### How to scan for vulnerabilities? + +- Trivy scans a docker image looking for software versions containing known vulnerabilities (CVEs). + It’s always a good idea to scan the image to ensure no new issues are introduced. + +- Run the following command to replicate the repo’s `CVE Scan` pipeline on an image build locally. + Note the pipeline runs nightly on the latest release version, so it can display issues solved in main branch. + + trivy image --severity HIGH,CRITICAL asciidoctor:latest + #### Deploy The goal for deploying is to make the Docker image available with the correct Docker tag in Docker Hub.