-
Notifications
You must be signed in to change notification settings - Fork 149
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #204 from juracy/main
Update README files from updatecli changes
- Loading branch information
Showing
6 changed files
with
167 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| tests | ||
| .git* | ||
| README-original.adoc | ||
| README.adoc | ||
| README.md | ||
| cache | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| = Asciidoctor Docker Container | ||
| :source-highlighter: coderay | ||
|
|
||
| //// | ||
| GitHub renders asciidoctor natively, but DockerHub does not (it needs markdown). | ||
| `make README.md` converts this page into markdown. | ||
| //// | ||
|
|
||
| == The environment | ||
|
|
||
| This Docker image provides: | ||
|
|
||
| * https://asciidoctor.org/[Asciidoctor] {ASCIIDOCTOR_VERSION} | ||
| * https://asciidoctor.org/docs/asciidoctor-diagram/[Asciidoctor Diagram] {ASCIIDOCTOR_DIAGRAM_VERSION} with ERD and Graphviz integration (supports plantuml and graphiz diagrams) | ||
| * https://asciidoctor.org/docs/asciidoctor-pdf/[Asciidoctor PDF] {ASCIIDOCTOR_PDF_VERSION} | ||
| * https://asciidoctor.org/docs/asciidoctor-epub3/[Asciidoctor EPUB3] {ASCIIDOCTOR_EPUB3_VERSION} | ||
| * https://github.com/asciidoctor/asciidoctor-fb2/[Asciidoctor FB2] {ASCIIDOCTOR_FB2_VERSION} | ||
| * https://github.com/asciidoctor/asciidoctor-mathematical[Asciidoctor Mathematical] {ASCIIDOCTOR_MATHEMATICAL_VERSION} | ||
| * https://docs.asciidoctor.org/reveal.js-converter/latest/[Asciidoctor reveal.js] {ASCIIDOCTOR_REVEALJS_VERSION} | ||
| * https://rubygems.org/gems/asciimath[AsciiMath] | ||
| * Source highlighting using http://rouge.jneen.net[Rouge], https://rubygems.org/gems/coderay[CodeRay] or https://pygments.org/[Pygments] | ||
| * https://github.com/asciidoctor/asciidoctor-confluence[Asciidoctor Confluence] {ASCIIDOCTOR_CONFLUENCE_VERSION} | ||
| * https://github.com/asciidoctor/asciidoctor-bibtex[Asciidoctor Bibtex] {ASCIIDOCTOR_BIBTEX_VERSION} | ||
|
|
||
| This image uses Alpine Linux 3.13 as base image. | ||
|
|
||
| == How to use it | ||
|
|
||
| Just run: | ||
|
|
||
| [source,bash] | ||
| ---- | ||
| docker run -it -v <your directory>:/documents/ asciidoctor/docker-asciidoctor | ||
| ---- | ||
|
|
||
| Docker maps your directory with [path]_/documents_ directory in the container. | ||
|
|
||
| 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. | ||
|
|
||
| * To run Asciidoctor on a basic AsciiDoc file: | ||
| + | ||
| [source,bash] | ||
| ---- | ||
| asciidoctor sample.adoc | ||
| asciidoctor-pdf sample.adoc | ||
| asciidoctor-epub3 sample.adoc | ||
| ---- | ||
|
|
||
| * To run AsciiDoc on an AsciiDoc file that contains diagrams: | ||
| + | ||
| [source,bash] | ||
| ---- | ||
| asciidoctor -r asciidoctor-diagram sample-with-diagram.adoc | ||
| asciidoctor-pdf -r asciidoctor-diagram sample-with-diagram.adoc | ||
| asciidoctor-epub3 -r asciidoctor-diagram sample-with-diagram.adoc | ||
| ---- | ||
|
|
||
| * To use Asciidoctor Confluence: | ||
| + | ||
| [source, bash] | ||
| ---- | ||
| asciidoctor-confluence --host HOSTNAME --spaceKey SPACEKEY --title TITLE --username USER --password PASSWORD sample.adoc | ||
| ---- | ||
|
|
||
| * To use Asciidoctor reveal.js with local downloaded reveal.js: | ||
| + | ||
| [source,bash] | ||
| ---- | ||
| asciidoctor-revealjs sample-slides.adoc | ||
| asciidoctor-revealjs -r asciidoctor-diagram sample-slides.adoc | ||
| ---- | ||
|
|
||
| * To use Asciidoctor reveal.js with online reveal.js: | ||
| + | ||
| [source,bash] | ||
| ---- | ||
| asciidoctor-revealjs -a revealjsdir=https://cdnjs.cloudflare.com/ajax/libs/reveal.js/3.9.2 sample-slides.adoc | ||
| asciidoctor-revealjs -a revealjsdir=https://cdnjs.cloudflare.com/ajax/libs/reveal.js/3.9.2 -r asciidoctor-diagram sample-slides.adoc | ||
| ---- | ||
|
|
||
| * To convert files in batch: | ||
| + | ||
| [source, bash] | ||
| ---- | ||
| docker run --rm -v $(pwd):/documents/ asciidoctor/docker-asciidoctor asciidoctor-pdf index.adoc | ||
| ---- | ||
|
|
||
| == How to contribute / do it yourself? | ||
|
|
||
| === Requirements | ||
|
|
||
| You need the following tools: | ||
|
|
||
| * A bash compliant command line | ||
| * link:http://man7.org/linux/man-pages/man1/make.1.html[GNU make] | ||
| * link:https://github.com/sstephenson/bats[Bats] installed and in your bash PATH | ||
| * Docker installed and in your path | ||
|
|
||
| === 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. | ||
|
|
||
| * You just have to run the Bats test suite, from the repository root: | ||
| + | ||
| [source,bash] | ||
| ---- | ||
| make test | ||
| ---- | ||
|
|
||
| ==== Include test in your build pipeline or test manually | ||
|
|
||
| You can use Bats directly to test the image. | ||
| Optionally, you can specify a custom image name: | ||
|
|
||
| [source,bash] | ||
| ---- | ||
| # If you want to use a custom name for the image, OPTIONAL | ||
| export DOCKER_IMAGE_NAME_TO_TEST=your-image-name | ||
| bats tests/*.bats | ||
| ---- | ||
|
|
||
| ==== Deploy | ||
|
|
||
| The goal for deploying is to make the Docker image available with the correct Docker tag in Docker Hub. | ||
|
|
||
| As a matter of trust and transparency for the end-users, the image is rebuilt by Docker Hub itself by triggering a build. | ||
| This only works under the hypothesis of a minimalistic variation between the Docker build in the CI, and the Docker build by Docker Hub. | ||
|
|
||
| Deploying the image requires setting the following environment variables: `DOCKERHUB_SOURCE_TOKEN` and `DOCKERHUB_TRIGGER_TOKEN`. | ||
| Their values come from a Docker Hub trigger URL: `https://hub.docker.com/api/build/v1/source/${DOCKERHUB_SOURCE_TOKEN}/trigger/${DOCKERHUB_TRIGGER_TOKEN}/call/`. | ||
|
|
||
| You might want to set these variables as secret values in your CI to avoid any leaking in the output (as `curl` output for instance). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters