Skip to content

Commit

Permalink
Tag v2.0.0 (#12)
Browse files Browse the repository at this point in the history
  • Loading branch information
Callum027 authored Feb 12, 2024
1 parent eb6bb8a commit 9787410
Show file tree
Hide file tree
Showing 3 changed files with 75 additions and 1 deletion.
35 changes: 35 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,41 @@ Palworld Dedicated Server Ansible Collection Release Notes
.. contents:: Topics


v2.0.0
======

Release Summary
---------------

This release adds support for orchestrating a Prometheus exporter alongside the Palworld Dedicated Server.

Enable it by setting ``palworld_dedicated_server_exporter_enable`` to ``true``, and configure the bind IP address and port with ``palworld_dedicated_server_exporter_bind_address`` (defaults to ``0.0.0.0``) and ``palworld_dedicated_server_exporter_bind_port`` (defaults to ``9877``).

This is a major version upgrade as unfortunately a number of breaking changes were required in this release. In the future the necessity of major version releases like this should decrease.


Major Changes
-------------

- Add support for orchestrating the `bostrt/palworld-exporter <https://hub.docker.com/r/bostrt/palworld-exporter>`_ Prometheus exporter, `developed by palworld.lol <https://github.com/palworldlol/palworld-exporter>`_, alongside Palworld Dedicated Server.

Minor Changes
-------------

- The Palworld Dedicated Server's bind address for external access is now configurable using ``palworld_dedicated_server_exporter_bind_address``, which defaults to ``0.0.0.0``.

Breaking Changes / Porting Guide
--------------------------------

- The Palworld server admin password is now set in the ``palworld_dedicated_server_admin_password`` inventory variable. It can no longer be defined by setting ``ADMIN_PASSWORD`` in ``palworld_dedicated_server_settings`` (this value will now be ignored).
- The ``palworld_dedicated_server_public_port`` inventory variable has been renamed to ``palworld_dedicated_server_bind_port``.
- The ``palworld_dedicated_server_rcon_port`` inventory variable has been renamed to ``palworld_dedicated_server_rcon_bind_port``.

Bugfixes
--------

- Fix syntax errors in the compose file causing the service start to error out when RCON is enabled.

v1.0.1
======

Expand Down
2 changes: 1 addition & 1 deletion changelogs/.plugin-cache.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ plugins:
strategy: {}
test: {}
vars: {}
version: 1.0.1
version: 2.0.0
39 changes: 39 additions & 0 deletions changelogs/changelog.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,42 @@ releases:
fragments:
- 1.0.1.yaml
release_date: '2024-02-10'
2.0.0:
changes:
breaking_changes:
- The Palworld server admin password is now set in the ``palworld_dedicated_server_admin_password``
inventory variable. It can no longer be defined by setting ``ADMIN_PASSWORD``
in ``palworld_dedicated_server_settings`` (this value will now be ignored).
- The ``palworld_dedicated_server_public_port`` inventory variable has been
renamed to ``palworld_dedicated_server_bind_port``.
- The ``palworld_dedicated_server_rcon_port`` inventory variable has been renamed
to ``palworld_dedicated_server_rcon_bind_port``.
bugfixes:
- Fix syntax errors in the compose file causing the service start to error out
when RCON is enabled.
major_changes:
- Add support for orchestrating the `bostrt/palworld-exporter <https://hub.docker.com/r/bostrt/palworld-exporter>`_
Prometheus exporter, `developed by palworld.lol <https://github.com/palworldlol/palworld-exporter>`_,
alongside Palworld Dedicated Server.
minor_changes:
- The Palworld Dedicated Server's bind address for external access is now configurable
using ``palworld_dedicated_server_exporter_bind_address``, which defaults
to ``0.0.0.0``.
release_summary: 'This release adds support for orchestrating a Prometheus exporter
alongside the Palworld Dedicated Server.
Enable it by setting ``palworld_dedicated_server_exporter_enable`` to ``true``,
and configure the bind IP address and port with ``palworld_dedicated_server_exporter_bind_address``
(defaults to ``0.0.0.0``) and ``palworld_dedicated_server_exporter_bind_port``
(defaults to ``9877``).
This is a major version upgrade as unfortunately a number of breaking changes
were required in this release. In the future the necessity of major version
releases like this should decrease.
'
fragments:
- 2.0.0.yaml
release_date: '2024-02-13'

0 comments on commit 9787410

Please sign in to comment.