Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Change Log

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

v0.6.0 - 2025-12-04

Added

Feed

  • Add display preferences
    • Filter displayed entries by reading status (all / read / unread)
    • Toggle entry summary visibility
  • For each displayed entry, add a link to the corresponding subscription
  • Collapse and expand subscription categories
  • Set a timeout for scheduled synchronization tasks

WWW

  • Add user preferences page
  • Propagate request and task context to the Services and Repositories

Packaging and automation

  • Add Make target to reindex the development database and refresh collation version
  • Update .gitignore and .dockerignore to exclude JetBrains IDE configuration

Changed

CLI

  • Allow to migrate to a specific database schema version
  • Simplify database migration logging

Feed

  • Handle cases where an entry's publication and/or update date(s) are zero, and fall back to the current date/time

Packaging and automation

  • Update direct and transitive dependencies
  • Bump github.com/jaswdr/faker to v2.9.0
  • Enable esbuild watch mode for live asset rebuilding
  • Run assets pipeline and Go server concurrently to avoid live server interruptions

Repository

  • Document query and transaction helpers
  • Cleanup SQL queries

WWW

  • Indicate browsers that only a light theme is available
  • Homogenize all forms to use horizontal fields
  • Rework the feed subscription management page
  • Rework the bookmarks tag management page

Fixed

Feed

  • If we fail to parse an XML feed due to invalid Unicode characters, filter them out and attempt to parse the feed again

WWW

  • Fix <time> blocks in bookmark and feed list pages
  • Use the same plus sign icon for bookmark and feed navbar menu items

v0.5.1 - 2025-08-16

Added

Documentation

  • Add high-level roadmap using the Now / Next / Later format

WWW

  • Add robots.txt route

Changed

Packaging and automation

  • Add Make targets to dump and restore the database
  • Upgrade PostgreSQL to version 17
  • Build with Go 1.25
  • Update direct and transitive dependencies
  • Switch to Debian 13 Trixie for the final image

WWW

  • Resolve assets with Node 24 LTS
  • Update Web manifest
  • Update FontAwesome to 7.0.0
  • Log view rendering errors
  • Rework home view rendering
  • Ensure services are initialized before starting the server
  • Skip the user session middleware for static pages and assets

Fixed

WWW

  • Prevent feed entries containing long sequences of non-whitespace characters from overflowing
  • Do not render feed entry text as Markdown
  • Fix pagination for the one but last page

v0.5.0 - 2025-06-01

Security

Added

Bookmarks

  • Export as a JSON document

WWW

  • Resolve and deploy frontend assets with NPM and esbuild

Changed

WWW

  • Log pagination errors as warnings
  • Rewrite HTML templates and CSS with the Bulma framework
  • Rework site navigation using navbar dropdowns
  • Rework search forms
  • Rework result pagination templates and helpers

Packaging and automation

  • Build with Go 1.24
  • Update CI workflow
  • Update direct and transitive dependencies
  • Run the modernize analyzer and apply fixes
  • Bump golangci-lint to v2
  • Setup golangci-lint to run additional linters

Removed

Feed

  • Remove unused importing.Repository type

v0.4.3 - 2025-01-05

Fixed

Feeds

  • Ensure truncating entry descriptions does not result in invalid UTF-8 code points

v0.4.2 - 2024-12-21

Changed

Feeds

  • When deleting a category or subscription, propagate the deletion to feeds with no remaining subscriptions

Security

v0.4.1 - 2024-12-14

Security

v0.4.0 - 2024-12-10

Added

Database

  • Add PostgreSQL integration tests for feed operations

Changed

Database

  • Split PostgreSQL repository into dedicated domain repositories
  • Update testcontainers configuration to use a tmpfs volume and disable WAL features to speed up integration tests

Feeds

  • Update page title to display the subscription alias (if set) or the feed title
  • Update listed entries to display the subscription alias (if set) or the feed title

WWW

  • Relocate HTTP packages to internal/http
  • Relocate version detection helpers to internal/version

v0.3.1 - 2024-12-07

Fixed

Feeds

  • Fix HTML templates after renaming querying models

v0.3.0 - 2024-12-07

Added

Database

  • Add dedicated tests for PostrgeSQL database migrations (up/down)

Documentation

  • Add custom CSS to display wider content on large screens

Feeds

  • For each entry in the list, display the title of the corresponding feed
  • Save and display feed descriptions
  • Extract keywords (significant terms) from entry content/description with TextRank
  • Add full-text search based on feed and entry metadata
  • Store and compare the hash (xxHash64) of the feed data to avoid unnecessary database upserts
  • Document the feed polling and caching strategy
  • Allow users to set an alias title for feed subscriptions

Changed

CI

  • Lint and format SQL files with SQLFluff
  • Publish HTML documentation to GitHub Pages

Documentation

  • Update documentation structure to follow the Diátaxis approach
  • Disable mdBook file auto-creation
  • Check for broken links with mdbook-linkcheck

www

  • Update the home page
  • Render HTTP 4xx errors as HTML views

Fixed

Docker

  • Install the ca-certificates package in the Docker image for TLS connections

Feeds

  • Ensure entry publication and update dates are non-zero
  • Ensure entry publication and update dates are not in the (far) future (limit: 2 days)
  • In the subscription edit form, ensure the correct category is selected

v0.2.0 - 2024-11-14

Added

Feeds

  • Subscribe to Atom and RSS feeds
  • Categorize subscriptions
  • Display subscriptions
  • Periodically synchronize subscriptions
  • Import existing subscriptions from OPML
  • Export subscriptions

Changed

Bookmarks

  • Enforce CSRF validation for import and export forms

PostgreSQL

  • Update repository helpers

Packaging & automation

  • Build with Go 1.23
  • Update direct and transitive dependencies

v0.1.1 - 2024-01-26

Initial release

Added

Bookmarks

  • Create and manage users of the application
  • Create and manage bookmarks to Web pages (links)
  • Display bookmarks and bookmark tags
  • Import existing bookmarks
  • Search bookmarks by keywords (full-text search)

Command-line & configuration

  • Add a sparklemuffin root command to handle common program configuration
  • Add a createadmin subcommand to create users with administrator privileges
  • Add a migrate subcommand to manage database migrations
  • Add a run subcommand to start all services
  • Add a version subcommand to display the running version (featuring Git version information)
  • Allow configuring services via:
    • application defaults
    • configuration file
    • command-line flags
    • environment variables

Observability

  • Setup structured logging (formats: console, JSON)
  • Expose Prometheus metrics:
    • Go runtime
    • HTTP requests
    • Application build and version information

Packaging & automation

  • Package the application as a Docker container
  • Provide Docker Compose configuration for:
    • local development
    • example usage
  • Add mdBook documentation
  • Add Make targets to:
    • run static analysis tools (linters)
    • run unitary tests
    • run integration tests
    • generate coverage reports
    • run live-reload development servers
    • build HTML documentation
  • Add GitHub Actions workflows:
    • CI: build the application, run linters, run tests
    • Copywrite: ensure license headers are present in source files
    • Docker: build and publish Docker image to the GitHub Container Registry (GHCR)