From d66c1e97890ed03ef97754c6beb65c62cb31ef39 Mon Sep 17 00:00:00 2001 From: damien clochard Date: Tue, 27 May 2025 12:30:22 +0200 Subject: [PATCH 1/2] Add deprecation notes about the `full` variant --- CHANGELOG.md | 13 ++++++++----- CONTRIBUTING.md | 8 +++----- README.md | 27 +++++++++++++-------------- 3 files changed, 24 insertions(+), 24 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b77962c..49774af 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,20 +1,23 @@ Changelog =============================================================================== -25.03 - Work in Progress +25.05 - Maintenance Version ------------------------------------------------------------------------------- __Stack__ * Ubuntu Noble -* pandoc/extra:3.6 -* Pandoc 3.6 -* Eisvogel 2.5.0 +* pandoc/extra:3.7 +* Pandoc 3.7 +* Eisvogel 3.2.0 __Changes__ * Add silence package (#286) -* Update to pandoc 3.6 +* Update to pandoc 3.7 +* FIX #289: Use standard PANDOC_DATA_DIR for templates +* Deprecate the full variant + 24.05 - Simplification and transfer toward upstream pandoc/extra ------------------------------------------------------------------------------- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c9e8464..c3b739b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,16 +21,14 @@ How To Submit a Patch 1. Run `make all` locally to build your modifications before submitting 2. Run `make test` to pass all the regession tests -2. Check that you have included the media files necessary to test your patch +3. Check that you have included the media files necessary to test your patch Upgrade the Pandoc version ------------------------------------------------------------------------------- 1. Check for the latest release of Pandoc here: https://github.com/jgm/pandoc/releases -2. Check for the latest release of Crossref here: https://github.com/lierdakil/pandoc-crossref/releases -3. Modify the `PANDOC_VERSION` and `PANDOC_CROSSREF_VERSION` variables in the [Makefile](Makefile) -4. Modify the `PANDOC_VERSION` and `PANDOC_CROSSREF_VERSION` variables in the [buster/Dockerfile](buster/Dockerfile) -4. Modify the image tag and `PANDOC_CROSSREF_VERSION` variable in the [alpine/Dockerfile](alpine/Dockerfile) +2. Check for the latest release of the pandoc/extra image here: https://hub.docker.com/r/pandoc/extra +3. Modify the image tag in `Dockerfile` Handling your personal data ------------------------------------------------------------------------------- diff --git a/README.md b/README.md index f9704fe..905fb1a 100644 --- a/README.md +++ b/README.md @@ -91,7 +91,7 @@ Please go the project page of each template for more details. ## Filters -This docker image embeds a number of usefull pandoc filters. You can simply +This docker image embeds a number of useful pandoc filters. You can simply enable them by adding the option `--filter xxx` where `xxx` is the name of one of the following filters below: @@ -132,7 +132,6 @@ and [pandoc-mustache] filters. [pandoc-latex-margin]: https://github.com/chdemko/pandoc-latex-margin [pandoc-latex-newpage]: https://github.com/chdemko/pandoc-latex-newpage [pandoc-mustache]: https://github.com/michaelstepner/pandoc-mustache - [pandoc-crossref]: https://github.com/lierdakil/pandoc-crossref [pandoc-run-postgres]: https://github.com/daamien/pandoc-run-postgres [pandoc-jinja]: https://github.com/daamien/pandoc-jinja @@ -146,25 +145,25 @@ The pandocker image includes the following open-source fonts: * Liberation: * Fontawesome: -The full variant includes - -* Noto: - -## Supported Tags : Branch + Variant + Parent +## Supported Tags -The image is available in 4 versions named as follows: +The image is available in 2 versions named as follows: -* `latest` (default): minimal image containing the most recent changes -* `stable` : minimal image based on the latest stable release -* `latest-full` (default): complete image containing the most recent changes -* `stable-full` : complete image based on the latest stable release +* `latest` (default): image containing the most recent changes +* `stable`: image based on the latest stable release You can also the release names for instance `docker pull dalibo/pandocker:24.05` -the previous versions add more complex tags such as `latest-ubuntu-extra` -or `stable-buster`. They are not supported anymore. +## DEPRECATION NOTICE + +The previous versions add more complex tags such as `latest-ubuntu-extra` +or `stable-buster`. + +We also provided alternative image named `latest-full and `stable-full`. + +They are not supported anymore. ## Build it From 7c6573600a576565696496308ef570095010c146 Mon Sep 17 00:00:00 2001 From: damien clochard Date: Tue, 27 May 2025 12:35:49 +0200 Subject: [PATCH 2/2] Release 25.05 --- .github/workflows/docker_hub.yml | 4 +- NEWS.md | 81 ++++++++++++++++++++++++++++++-- 2 files changed, 78 insertions(+), 7 deletions(-) diff --git a/.github/workflows/docker_hub.yml b/.github/workflows/docker_hub.yml index 49d9949..f269894 100644 --- a/.github/workflows/docker_hub.yml +++ b/.github/workflows/docker_hub.yml @@ -5,7 +5,7 @@ name: Publish Docker images on: workflow_dispatch: # manually triggered push: - branches: [ latest, stable, 24.05 ] + branches: [ latest, stable, 25.05 ] jobs: push_to_registry: @@ -47,4 +47,4 @@ jobs: file: Dockerfile push: true target: full - tags: dalibo/pandocker:${{ steps.branch.outputs.branch_name }}-full \ No newline at end of file + tags: dalibo/pandocker:${{ steps.branch.outputs.branch_name }}-full diff --git a/NEWS.md b/NEWS.md index e98a1b0..0a4c951 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,4 +1,75 @@ +Pandocker 25.05: Maintenance Release +================================================================================ + +Eymoutiers, May 17, 2025 + +What is this ? +-------------------------------------------------------------------------------- + +Pandocker is a docker image that extends the official [pandoc/extra image] with +with more filters, templates, fonts, and the latex bazaar + +[pandoc/extra image]: https://hub.docker.com/r/pandoc/extra + +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 4 main tags: + +* `stable` should be used in production +* `latest` is the development versions + +You can also retrieve older versions by their version number: +`dalibo/pandocker:25.05`, `dalibo/pandocker:24.05`, etc. + +For more details : + +* Github : +* Docker Hub : + + +Pandoc 3.7 and Eisvogel 3.2 +-------------------------------------------------------------------------------- + +This new version bring new updates of the major components, based on the +[pandoc/dockerfiles] upstream project. + + +How to upgrade +-------------------------------------------------------------------------------- + +```console +docker pull dalibo/pandocker:stable +``` + +Credits +-------------------------------------------------------------------------------- + +It is also heavily based on the great work by Albert Krewinkel and +Caleb Maclennan on the [pandoc/dockerfiles] project. + +Many thanks to them ! + +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: + + + + + Pandocker 24.05: Simplification and transfer toward upstream pandoc/extra ================================================================================ @@ -41,11 +112,11 @@ Simplification -------------------------------------------------------------------------------- When we started this project 8 years ago, there was no official docker image for -pandoc. Thus we made our own. +pandoc. Thus we made our own. -Over the last year, we worked hand in hand with the [pandoc/dockerfiles] to -create a new [pandoc/extra image] that includes key parts of the former -pandocker versions. And therefore the `dalibo/pandocker` image is now based on +Over the last year, we worked hand in hand with the [pandoc/dockerfiles] to +create a new [pandoc/extra image] that includes key parts of the former +pandocker versions. And therefore the `dalibo/pandocker` image is now based on the [pandoc/extra image]. [pandoc/dockerfiles]: https://github.com/pandoc/dockerfiles/ @@ -68,7 +139,7 @@ Credits The release contains contributions from Peter Dave Hello and Giovanni Rosa. -It is also heavily based on the great work by Albert Krewinkel and +It is also heavily based on the great work by Albert Krewinkel and Caleb Maclennan on the [pandoc/dockerfiles] project. Many thanks to them !