v3.0.5

What's New

• bump dependencies to resolve dependabot issue

Install Latest Version: go get github.com/jonasdoesthings/plavatar/v3@v3.0.5
Full Changelog: v3.0.4...v3.0.5

v3.0.4

What's New

• fix pixel avatar generating no circle in svg mode
• bump dependency versions
• bump go to 1.22

Install Latest Version: go get github.com/jonasdoesthings/plavatar/v3@v3.0.4
Full Changelog: v3.0.3...v3.0.4

v3.0.3

What's New

This release updates dependencies to mitigate potential denial of service bugs.

Install Latest Version: go get github.com/jonasdoesthings/plavatar/v3@v3.0.3
Full Changelog: v3.0.2...v3.0.3

v3.0.2

What's New

This release removes the requirement of setting an OutputSize for SVG images. SVG images do not respect the passed OutputSize anyways, so the requirement didn't make sense in this case.

Besides that only a few docs and test related changes were done.

Install Latest Version: go get github.com/jonasdoesthings/plavatar/v3@v3.0.2
Full Changelog: v3.0.1...v3.0.2

v3 | Package Splitup

Breaking Release

This release splits up the project into plavatar (this repository) and plavatar-rest (https://github.com/JonasDoesThings/plavatar-rest).

Plavatar is now usable as a normal local golang library. The rest microservice still lives and is maintained, but moved to the other repository.

The up-to-date plavatar-rest docker image can be found here: https://github.com/JonasDoesThings/plavatar-rest/pkgs/container/plavatar-rest

The plavatar-rest docker image now is named (ghcr.io)/jonasdoesthings/plavatar-rest

To install the library, run go get github.com/jonasdoesthings/plavatar/v3
Full Changelog: v2.0.0...v3.0.1

v2.0.0 | SVG Format, Square-Shape, Code Quality, Performance Improvements

What's New

SVGs

The entire generation process is now based on SVGs. You can request the SVG directory by appending ?format=svg to your request. By default the SVG will be rasterised to a PNG like before.

If you can, use SVGs, since they are not only around 2% of the size of the same PNG, but also way faster to generate, since the server does not need to do the extra conversion.

Square Shape

By adding the query parameter ?shape=square to your request, you can now request the square-shaped avatar. (See comparison picture below)

Code Quality, Performance

A lot of code changes were done under the hood. The code is more maintainable, less repeated, and faster now. Libraries were replaced to accomodate the new SVG-first logic. A few tests were also added. The CI/CD Pipeline was greatly improved.

Performance Comparison:
plavatar 2.0 PNG vs plavatar 1.0 PNG: +11%
plavatar 2.0 SVG vs plavatar 1.0 PNG: +5100% (!)
(tested on a 512MB docker container)

Breaking

While the color themselves stay the same, facial features (mouth, eyes) will be different for the same seed compared to plavatar 1.0. (See comparison picture below)

Comparison of the look from v1 vs v2:

Docker Image: https://github.com/JonasDoesThings/plavatar/pkgs/container/plavatar/107775107?tag=v2.0.0 (ghcr.io/jonasdoesthings/plavatar:v2.0.0)
Full Changelog: https://github.com/JonasDoesThings/plavatar/commits/v2.0.0

v1.2.0 - GitHub Renaming

Warning

The Repository, and thus the package was moved from k4ds3/plavatar to https://github.com/JonasDoesThings/plavatar due to account renaming!

Feat

• Add optional prometheus /metrics endpoint

Build

• Bump Go Version to 1.20 (greatly improves performance, see https://twitter.com/JonasDoesThings/status/1621634131770875906)
• Update CI Pipeline after repository move

Changes

• Enable gzip by default in default config

Package: https://github.com/JonasDoesThings/plavatar/pkgs/container/plavatar
Full Changelog: v1.1.1...v1.2.0

v1.1.1

• add config setting for max/min dimensions
• bump golang version to 1.18
• bump dependency versions

Package: https://github.com/k4ds3/plavatar/pkgs/container/plavatar
Full Changelog: v1.1.0...v1.1.1

v1.1.0

First Full Release

Package: https://github.com/k4ds3/plavatar/pkgs/container/plavatar