Merge pull request #192 from dalibo/191_release_21_02

Release 21.02

.github/workflows/alpine.yml

@@ -1,7 +1,7 @@
 name: Alpine Image (alt) Regression Tests
 
 # disable automatic testing for Alpine until we decide what goes in alpine vs. alpine-full
-# on: [push, workflow_dispatch] 
+# on: [push, workflow_dispatch]
 on: [workflow_dispatch]
 
 jobs:
@@ -20,4 +20,4 @@ jobs:
       run: docker build . --file alpine/Dockerfile --tag dalibo/pandocker:xxxxx-test-githubci-xxxxx
 
     - name: Regression Tests
-      run: TAG=xxxxx-test-githubci-xxxxx VARIANT=alpine ./tests/libs/bats-core/bin/bats tests/docker.bats --tap
+      run: TAG=xxxxx-test-githubci-xxxxx VARIANT=alpine ./tests/libs/bats-core/bin/bats tests/extra.bats --tap

.github/workflows/buster.yml

@@ -16,7 +16,7 @@ jobs:
       run: docker build . --file buster/Dockerfile --tag dalibo/pandocker:xxxxx-test-githubci-buster
 
     - name: Regression Tests
-      run: TAG=xxxxx-test-githubci-buster VARIANT=buster ./tests/libs/bats-core/bin/bats tests/docker.bats --tap
+      run: TAG=xxxxx-test-githubci-buster VARIANT=buster ./tests/libs/bats-core/bin/bats tests/extra.bats --tap
 
   full:
     runs-on: ubuntu-latest

.github/workflows/stretch.yml

@@ -18,4 +18,4 @@ jobs:
       run: docker build . --file stretch/Dockerfile --tag dalibo/pandocker:xxxxx-test-githubci-xxxxx
 
     - name: Regression Tests
-      run: TAG=xxxxx-test-githubci-xxxxx VARIANT=stretch ./tests/libs/bats-core/bin/bats tests/docker.bats --tap
+      run: TAG=xxxxx-test-githubci-xxxxx VARIANT=stretch ./tests/libs/bats-core/bin/bats tests/extra.bats --tap

CHANGELOG.md

@@ -1,18 +1,33 @@
 Changelog
 ===============================================================================
 
-20.05 - WIP
+21.02
 -------------------------------------------------------------------------------
 
 __Stack__
 
-* Debian 9 stretch
-* Pandoc 2.9
-* Eisvogel 1.4.0
+* Debian 10 buster
+* Pandoc 2.11
+* Eisvogel 2.0
 
 __Changes__
 
-
+<https://github.com/dalibo/pandocker/milestone/11>
+
+* Upgrade to debian buster
+* Upgrade to pandoc 2.11
+* Upgrade to eisvogel 2.0
+* Add an experimental alpine variant based on `pandoc:latex`
+* Create a `latest-buster-full` tag for huge packages
+* Archive the debian stretch version
+* [full] Add support for Hindi ( Sponsored by OWASP Foundation )
+* [full] Add support for Persian ( Sponsored by OWASP Foundation )
+* [full] restore Noto Font
+* [filters] `pandoc-citeproc` is now obsolete, use `--citeproc` instead
+* [fonts] Add fontawesome5 to allow awesomebox to work (@vvishnyakov)
+* Add support for Spanish in latex (@iapellaniz)
+* Remove pandoc 1.x compatibility
+* Disable Circle CI
 
 20.02
 -------------------------------------------------------------------------------

INSTALL.md

@@ -1,5 +1,9 @@
 # Install the Pandocker toolchain
 
+> WARNING: This page is not maintained anymore and we are planning to remove
+> it in further versions. Please open an issue if this was useful to you.
+
+²
 ## With docker
 
 ```

Makefile

@@ -79,7 +79,7 @@ buster-full: buster-full/Dockerfile
 
 .PHONY: test
 test:
-	$(BATS) $(BATS_FILTER) tests/docker.bats
+	$(BATS) $(BATS_FILTER) tests/extra.bats
 
 .PHONY: test-full
 test-full:

NEWS.md

@@ -1,3 +1,116 @@
+
+Pandocker 21.02: Major upgrade
+================================================================================
+
+Paris, March 1rst, 2021
+
+What is this ?
+--------------------------------------------------------------------------------
+
+Pandocker is a docker image containing a complete document production toolchain
+based on `pandoc` with filters, templates, fonts, and the latex bazaar
+
+It allows you to generate slides and documents without installing the required
+depencies on your machine. It is also very usefull to integrate pandoc into
+a CI workflow such as Github Actions, Gitlab Pipelines, etc.
+
+For instance to generate an EPUB file from a markdown source, you can simply
+type:
+
+```
+docker run --rm -v `pwd`:/pandoc dalibo/pandocker test.md -o test.epub
+```
+
+This image is available under BSD Licence and it has 2 main tags:
+
+* `stable` should be used in production
+* `stable-full` for non-european languages
+* `latest` and `latest-full` are the development versions
+
+You can also retrieve older versions by their version number:
+`dalibo/pandocker:19.11`, `dalibo/pandocker:21.02-full`, etc.
+
+For more details :
+
+* Github : <https://github.com/dalibo/pandocker>
+* Docker Hub : <https://hub.docker.com/r/dalibo/pandocker/>
+
+
+Major Upgrades
+--------------------------------------------------------------------------------
+
+This new version is now based on Debian 10 buster (instead of Stretch) with
+pandoc 2.11 and the version 2.0 of the eisvogel template. We have done careful
+regression tests but these changes may introduce minor changes in the rendered
+output of your documents. Please open a ticket if you notice a problematic
+behaviour.
+
+
+Support for Arabic, Persian, Hindi and CJK languages
+--------------------------------------------------------------------------------
+
+The docker image has now a new variant named `full` that will included
+non-european fonts, especially the complete [Noto font]. This font family is
+designed to support all languages.
+
+[Noto font]: https://www.google.com/get/noto/
+
+We also included latex font packages such as [devanagari] for Hindi and
+[farsiweb] for Persian. Right-to-Left typesetting is also supported.
+
+[devanagari]: https://www.ctan.org/pkg/devanagari
+[farsiweb]: https://packages.debian.org/sid/fonts-farsiweb
+
+To use these fonts, you can simply define the `mainfont` variable inside the
+markdown front-matter or via the pandoc command line with the `-v` (or
+`--variable` option) :
+
+```shell
+docker run [...] dalibo/pandocker [...] hindi.md -o hindi.pdf -v mainfont='Lohit Devanagari'
+```
+
+For Noto:
+
+```shell
+docker run [...] dalibo/pandocker [...] foo.md -o foo.pdf -v mainfont='Noto Sans'
+```
+
+**IMPORTANT:** The `full` docker image size is approx. 800MB whereas the regular
+is "only" 320 MB. We recommend that you use the `full` variant only when needed
+and prefer the regular variant for basic use cases.
+
+The support for Hindi and Persian was sponsored by the [OWASP Foundation]. Many
+thanks to them ! Many thanks also to @iapellaniz and @vvishnyakov who contributed
+to the release.
+
+[OWASP Foundation]: https://owasp.org/
+[Noto font]: https://www.google.com/get/noto/
+[devanagari]: https://www.ctan.org/pkg/devanagari
+[farsiweb]: https://packages.debian.org/sid/fonts-farsiweb
+
+
+How to upgrade
+--------------------------------------------------------------------------------
+
+```console
+docker pull dalibo/pandocker:stable
+```
+
+
+How to contribute
+--------------------------------------------------------------------------------
+
+Pandocker is an open project, contributions are welcome.
+
+If you want to help, you can find a list of "Junior Jobs" here:
+
+<https://github.com/dalibo/pandocker/labels/Junior%20Job>
+
+
+
+---
+
+
 Pandocker 20.02: the palindrome edition !
 ================================================================================
 

README.md

@@ -3,7 +3,7 @@
 [![github
 release](https://img.shields.io/github/release/dalibo/pandocker.svg?label=current+release)](https://github.com/dalibo/pandocker/releases)
 [![Docker Image](https://images.microbadger.com/badges/image/dalibo/pandocker.svg)](https://hub.docker.com/r/dalibo/pandocker)
-[![CI](https://circleci.com/gh/dalibo/pandocker.svg?style=shield)](https://circleci.com/gh/dalibo/pandocker)
+[![CI buster](https://github.com/dalibo/pandocker/actions/workflows/buster.yml/badge.svg?branch=latest)](https://github.com/dalibo/pandocker/actions/workflows/buster.yml)
 [![License](https://img.shields.io/github/license/dalibo/pandocker.svg)](https://github.com/dalibo/pandocker/blob/master/LICENSE)
 [![Last Commit](https://img.shields.io/github/last-commit/dalibo/pandocker.svg)](https://github.com/dalibo/pandocker/branches)
 
@@ -122,14 +122,28 @@ The pandocker image includes the following open-source fonts:
 * Lato: https://fonts.google.com/specimen/Lato
 * Liberation: https://github.com/liberationfonts/liberation-fonts
 
+The full variant includes
 
-## Supported Tags
+* Noto: https://www.google.com/get/noto/
 
-You can use 3 different versions of this machine with the following tags:
+## Supported Tags : Branch + Variant + Parent
 
-* `latest`: this is the default
-* `latest-alpine` : the latest version, based on alpine
-* `stable` or `20.02`: for production
+The image is available in multiple versions named as follows:
+
+`branch[-parent[-variant]]`
+
+* The __branch__ can be `latest` (default) or `stable` (for production)
+  or the release name (`20.02`)
+* The __parent__ is the base image we are using. Either `buster` (default)
+  or `alpine`
+* The __variant__ is either `extra` (330MB) or `full` (810 MB)
+
+The supported tags are :
+
+* `latest`, `latest-buster`, `latest-buster-extra` (default)
+* `latest-buster-full`
+* `stable`, `stable-buster`, `stable-buster-extra`
+* `stable-buster-full`
 
 Other tags are not supported and should be used with care.
 

UPGRADE.md

@@ -1,5 +1,9 @@
 # Upgrade the Pandocker toolchain
 
+> WARNING: This page is not maintained anymore and we are planning to remove
+> it in further versions. Please open an issue if this was useful to you.
+
+
 ## With docker
 
 ```

tests/docker.bats → tests/extra.bats

@@ -1,5 +1,7 @@
 #!/usr/bin/env bats
 
+## Example: TAG=stable TEXT_ONLY=413 bats extra.bats
+
 ##
 ## Useful fonctions
 ##
@@ -22,7 +24,6 @@ initial_setup(){
 }
 
 setup() {
-  # use `TAG=stable bats docker.bats` to test the stable version
   export TAG=${TAG:-latest}
   export VARIANT=${VARIANT:-}
   log "setup: TAG = $TAG & VARIANT=$VARIANT"
@@ -152,10 +153,9 @@ teardown() {
           -o $OUT/$DIR/markdown_nl.pdf
 }
 
-@test "413: Generate a PDF file containing Spanish characters" {
+@test "413: a PDF file containing Spanish characters" {
   DIR=spanish
   $PANDOC --pdf-engine=xelatex \
-          --template=$IN/$DIR/template_es.tex \
           $IN/$DIR/markdown_es.md \
           -o $OUT/$DIR/markdown_es.pdf
 }

tests/full.bats

@@ -3,6 +3,8 @@
 ##
 ## Testing the full variant
 ##
+## Example: TAG=stable TEXT_ONLY=1411 bats full.bats
+##
 
 log() {
   local -r log="$BATS_TEST_DIRNAME/${BATS_TEST_FILENAME##*/}.log"
@@ -22,7 +24,6 @@ initial_setup(){
 }
 
 setup() {
-  # use `TAG=stable bats docker.bats` to test the stable version
   export TAG=${TAG:-latest}
   export VARIANT=${VARIANT:-}
   log "setup: TAG = $TAG & VARIANT=$VARIANT"
@@ -33,7 +34,8 @@ setup() {
   export EXP=tests/expected
   export OUT=tests/output
   if [ "${BATS_TEST_NUMBER}" = 1 ];then
-    initial_setup
+    $
+initial_setup
   fi
 }
 

tests/input/spanish/markdown_es.md

@@ -4,6 +4,9 @@ author: Miguel de Cervantes
 date: 2021-02-22
 version: 20210222
 status: DRAFT
+
+header-includes: |
+    \usepackage[spanish]{babel}
 ---
 
 # Famoso comienzo
@@ -23,3 +26,4 @@ Quieren decir que tenía el sobrenombre de Quijada, o Quesada, que en esto hay a
 Pero esto importa poco a nuestro cuento: basta que en la narración dél no se salga un punto de la verdad.
 Es, pues, de saber que este sobredicho hidalgo, los ratos que estaba ocioso -que eran los más del año-, se daba a leer libros de caballerías, con tanta afición y gusto que olvidó casi de todo punto el ejercicio de la caza, y aun la administración de su hacienda; y llegó a tanto su curiosidad y desatino en esto, que vendió muchas hanegas de tierra de sembradura para comprar libros de caballerías en que leer, y así, llevó a su casa todos cuantos pudo haber dellos.
 Y, de todos, ningunos le parecían tan bien como los que compuso el famoso Feliciano de Silva, porque la claridad de su prosa y aquellas entricadas razones suyas le parecían de perlas; y más cuando llegaba a leer aquellos requiebros y cartas de desafíos, donde en muchas partes hallaba escrito: La razón de la sinrazón que a mi razón se hace, de tal manera mi razón enflaquece, que con razón me quejo de la vuestra fermosura. Y también cuando leía: los altos cielos que de vuestra divinidad divinamente con las estrellas os fortifican, y os hacen merecedora del merecimiento que merece la vuestra grandeza.
+