Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release 24.05 #283

Merged
merged 1 commit into from
May 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,32 @@
Changelog
===============================================================================

23.03 - WORK IN PROGRESS
24.05 - Simplification and transfer toward upstream pandoc/extra
-------------------------------------------------------------------------------

__Stack__

* Ubuntu Jammy
* pandoc/extra:3.2
* Pandoc 3.2
* Eisvogel 2.4.0

__Changes__

* Fix CI status badge in README.md (PeterDaveHello)
* Use Github Action to publish the images
* Update python filters
* Remove obsolete variants
* use multi-stage build
* Add the pandoc templates in the ubuntu $HOME
* remove deprecated tests
* use pip with --break-system-packages
* Update to pandoc 3.2
* Bump pygments from 2.13 to 2.15.0
* Fix for Dockerfile smell DL4006 (grosa1)


23.03 - Maintenance Version
-------------------------------------------------------------------------------

__Stack__
Expand Down
86 changes: 86 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,90 @@

Pandocker 24.05: Simplification and transfer toward upstream pandoc/extra
================================================================================

Eymoutiers, May 30, 2024

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
* `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:24.05`, `dalibo/pandocker:23.03-full`, etc.

For more details :

* Github : <https://github.com/dalibo/pandocker>
* Docker Hub : <https://hub.docker.com/r/dalibo/pandocker/>

Simplification
--------------------------------------------------------------------------------

When we started this project 8 years ago, there was no official docker image for
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
the [pandoc/extra image].

[pandoc/dockerfiles]: https://github.com/pandoc/dockerfiles/

By moving those key parts upstream, we can now greatly simplify this project and
improve its maintainability.

The `dalibo/pandocker` image will remain because it contains some elements that
cannot be pushed upstream.

How to upgrade
--------------------------------------------------------------------------------

```console
docker pull dalibo/pandocker:stable
```

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
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:

<https://github.com/dalibo/pandocker/labels/Junior%20Job>



Pandocker 23.03: Maintenance Version
================================================================================

Expand Down