Skip to main content

Releases and versions

Every GitHub release in a public repository of the EvilFlowersCatalog organization is listed on the releases page. Releases that change something for readers, librarians or operators also get a post in News.

Activity diagram: a maintainer publishes a GitHub release with tag X.Y.Z; CI builds what the tag ships; the site rebuild fetches the releases of every public repository and lists them on /releases; a notable release also gets a post on /news.
PlantUML source

Which repositories release today​

RepositoryTag exampleWhat the release contains
EvilFlowersCatalog0.15.0Release notes grouped by area, with upgrade notes
EvilFlowersViewerv0.7.9A version tag and a link to the changes; the reader is on npm
calibre-evilflowers2.1.0Notes from the changelog and the plugin ZIP, attached by CI
evilflowers-postgresqlr202611161245A dated build of the PostgreSQL image

The portal, the digitalizer, the lending worker and the processing workers do not tag releases yet. Their images are built from branches.

Reading a catalog release​

Catalog releases group changes by area and end with Upgrade notes. Items marked ⚠️ need action before or after you upgrade: a new database extension, a changed default, a command to run. When you skip versions, read the upgrade notes of every release in between.

Getting notified​

  • News feed (RSS; Atom) for announcements.
  • Watch → Custom → Releases on a GitHub repository for each of its releases.

For maintainers: the intended process​

The rest of this page is a proposal for the repositories that do not release yet. It is how we intend to work, not how every repository works today.

  1. Tag with X.Y.Z (a v prefix is accepted) and publish a GitHub release with notes. Keep a CHANGELOG.md, and copy the version's section into the release. Mark anything an operator must do with ⚠️ under Upgrade notes.

  2. Let CI build the tag. A service that uses evilflowers-actions publishes the container image :X.Y.Z for a tag X.Y.Z; moving the services to it is the first step. Tools attach their artifact to the release, as the Calibre plugin does.

  3. Ask the site to rebuild, optionally. Without this the release appears after the next daily rebuild. A workflow step on release: published can trigger it, with a token that may dispatch events to this repository:

    gh api repos/EvilFlowersCatalog/EvilFlowersCatalog.github.io/dispatches \
    -f event_type=release-published
  4. Write a post for a release that changes something for users: a pull request adding a file to news/ in this repository. Say what changed for whom and what to do; link the full notes instead of copying them.

How the releases page is built​

npm run releases (scripts/fetch-releases.mjs) asks the GitHub API for the releases of every public, non-fork repository in the organization and writes the tag, title, date and link of each to src/data/releases.json. The deploy workflow runs it before every build, on every push to main, once a day, and on a release-published dispatch. If GitHub cannot be reached, the committed file is used, so a build never fails because of the API.