chore: Add Release instructions + Changelog (#69)

* chore: Add Release instructions + Changelog

* mdl

CHANGELOG.md

@@ -0,0 +1,117 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [v1.3.4](https://github.com/Antiz96/Ankama-Launcher-Container/releases/tag/v1.3.4) - 2025-01-18
+
+- Update base image to base-20250118.0.299213 by @Antiz96 in #66
+
+## [v1.3.3](https://github.com/Antiz96/Ankama-Launcher-Container/releases/tag/v1.3.3) - 2025-01-05
+
+- Update base image to base-20250105.0.295189 by @Antiz96 in #65
+
+## [v1.3.2](https://github.com/Antiz96/Ankama-Launcher-Container/releases/tag/v1.3.2) - 2024-12-07
+
+- Update README by @Antiz96 in #63
+- Update image to base-20241207.0.286687 by @Antiz96 in #64
+
+## [v1.3.1](https://github.com/Antiz96/Ankama-Launcher-Container/releases/tag/v1.3.1) - 2024-10-16
+
+- Switch from firefox to chromium by @Antiz96 in #61
+
+## [v1.3.0](https://github.com/Antiz96/Ankama-Launcher-Container/releases/tag/v1.3.0) - 2024-10-16
+
+- Install xdg-utils and firefox in the container to fix the initial login to Ankama services by @Antiz96 in #59
+- Remove confusing sentences in README by @Antiz96 in #60
+
+## [v1.2.8](https://github.com/Antiz96/Ankama-Launcher-Container/releases/tag/v1.2.8) - 2024-10-16
+
+- Fix the curl command to download the Ankama Launcher by @Antiz96 in #58
+
+## [v1.2.7](https://github.com/Antiz96/Ankama-Launcher-Container/releases/tag/v1.2.7) - 2024-10-16
+
+- Switch to new Ankama launcher URL by @Antiz96 in #56
+- Rebuild container against archlinux:base-20241016.0.270464 by @Antiz96 in #57
+
+## [v1.2.6](https://github.com/Antiz96/Ankama-Launcher-Container/releases/tag/v1.2.6) - 2024-09-18
+
+- Periodic Rebuild by @Antiz96 in #55
+
+## [v1.2.5](https://github.com/Antiz96/Ankama-Launcher-Container/releases/tag/v1.2.5) - 2024-07-17
+
+- Periodic Rebuild by @Antiz96 in #54
+
+## [v1.2.4](https://github.com/Antiz96/Ankama-Launcher-Container/releases/tag/v1.2.4) - 2024-06-16
+
+- Periodic Rebuild by @Antiz96 in #53
+
+## [v1.2.3](https://github.com/Antiz96/Ankama-Launcher-Container/releases/tag/v1.2.3) - 2024-04-13
+
+- Add a trust path for users by @Antiz96 in #49
+- Periodic rebuild of the container by @Antiz96 in #51
+
+## [v1.2.2](https://github.com/Antiz96/Ankama-Launcher-Container/releases/tag/v1.2.2) - 2024-03-30
+
+- Rebuild to address the xz backdoor/security issue + switch to Arch's DockerHub repository by @Antiz96 in #48
+
+## [v1.2.1](https://github.com/Antiz96/Ankama-Launcher-Container/releases/tag/v1.2.1) - 2024-02-06
+
+- Periodic rebuild for glibc 2-39 update by @Antiz96 in #46
+
+## [v1.2.0](https://github.com/Antiz96/Ankama-Launcher-Container/releases/tag/v1.2.0) - 2024-01-22
+
+- Use a proper pacman command to clean cache by @Antiz96 in #37
+- Update base image to 20240101.0.204074 by @Antiz96 in #38
+- Fix pacman command to clean cache by @Antiz96 in #39
+- Ignore DL4006 in Hadolint by @Antiz96 in #42
+- Correct download link for the Ankama Launcher AppImage by @Antiz96 in #43
+
+## [v1.1.5](https://github.com/Antiz96/Ankama-Launcher-Container/releases/tag/v1.1.5) - 2023-12-13
+
+- Switch to a self-hosted runner for CI-CD + Add actionlint to CI by @Antiz96 in #32
+- Little optimization to the Dockerfile + Rebuild by @Antiz96 in #33
+- Switch to rootless Docker on the runner for CI/CD by @Antiz96 in #34
+
+## [v1.1.4](https://github.com/Antiz96/Ankama-Launcher-Container/releases/tag/v1.1.4) - 2023-11-11
+
+- Switch to action checkout v4 in CI by @Antiz96 in #29
+- Switch to docker/login-action@v3 in CD by @Antiz96 in #30
+- Bump image tag to 20231105.0.189722 by @Antiz96 in #31
+
+## [v1.1.3](https://github.com/Antiz96/Ankama-Launcher-Container/releases/tag/v1.1.3) - 2023-10-11
+
+- Update link for distrobox/podman installation guide for the steamdeck by @Antiz96 in #24
+- Remove custom config to accept 2 trailing spaces for mdl by @Antiz96 in #25
+- Rebuild to fix curl CVE-2023-38545 by @Antiz96 in #26
+
+## [v1.1.2](https://github.com/Antiz96/Ankama-Launcher-Container/releases/tag/v1.1.2) - 2023-09-08
+
+- Add more permissive permissions to the /opt/Ankama folder to prevent failing updates by @Antiz96 in #23
+
+## [v1.1.1](https://github.com/Antiz96/Ankama-Launcher-Container/releases/tag/v1.1.1) - 2023-09-04
+
+- Rebuild to include the latest Ankama Launcher's version @Antiz96 in #20
+
+## [v1.1.0](https://github.com/Antiz96/Ankama-Launcher-Container/releases/tag/v1.1.0) - 2023-08-24
+
+- Add support for the SteamDeck and SteamOS by @Antiz96 in <https://github.com/Antiz96/Ankama-Launcher-Container/pull/16>
+- Remove the `Terminal` statement for the rootless and SteamOS desktop files by @Antiz96 in <https://github.com/Antiz96/Ankama-Launcher-Container/pull/18>
+
+## [v1.0.3](https://github.com/Antiz96/Ankama-Launcher-Container/releases/tag/v1.0.3) - 2023-08-21
+
+- Rebuild to include the new Ankama launcher version by @Antiz96 in #14
+
+## [v1.0.2](https://github.com/Antiz96/Ankama-Launcher-Container/releases/tag/v1.0.2) - 2023-08-18
+
+- Use a precise tag for the Arch base image by @Antiz96 in #13
+
+## [v1.0.1](https://github.com/Antiz96/Ankama-Launcher-Container/releases/tag/v1.0.1) - 2023-08-10
+
+- Add basic info to the Dockerfile (Maintainer, Description) and remove the pacman cache during build by @Antiz96 in <https://github.com/Antiz96/Ankama-Launcher-Container/pull/11>
+- Correct the update/upgrade instructions in the README by @Antiz96 in <https://github.com/Antiz96/Ankama-Launcher-Container/pull/12>
+
+## [v1.0.0](https://github.com/Antiz96/Ankama-Launcher-Container/releases/tag/v1.0.0) - 2023-08-10
+
+- Initial Release
+
+<!-- generated by git-cliff -->

RELEASE.md

@@ -0,0 +1,47 @@
+# Creating a release
+
+- Make sure that `git-cliff` is installed.
+
+- Export a `TAG` variable containing the new tag for the release:
+
+```bash
+export TAG="X.Y.Z"
+```
+
+- Update changelog:
+
+```bash
+git-cliff -up CHANGELOG.md
+sed -i "s|\[unreleased\]|\[v${TAG}\](https://github.com/Antiz96/Ankama-Launcher-Container/releases/tag/v${TAG})\ -\ $(date '+%Y-%m-%d')|g" CHANGELOG.md
+```
+
+- Commit, sign and push changes directly to the **main branch** *(we want the tagged commit to be signed with the [OpenPGP Key](https://keyserver.ubuntu.com/pks/lookup?search=D33FAA16B937F3B2&fingerprint=on&op=index) listed in [MAINTAINERS.md](https://github.com/Antiz96/Ankama-Launcher-Container/blob/main/MAINTAINERS.md) and not with the GitHub signature key automatically used when merging a pull request; this implies **temporarily** allowing administrators to bypass branch protections rules)*:
+
+```bash
+git add .
+git commit -SD33FAA16B937F3B2 -m "chore(release): v${TAG}"
+git push
+```
+
+- Create, sign and push the new tag:
+
+```bash
+git tag v${TAG} -u D33FAA16B937F3B2 -m "v${TAG}"
+git push origin v${TAG}
+```
+
+- Create a release on GitHub, download and sign the auto-generated source tarball:
+
+```bash
+cd ~/Downloads
+gpg --local-user D33FAA16B937F3B2 --armor --detach-sign Ankama-Launcher-Container-${TAG}.tar.gz
+sha256sum Ankama-Launcher-Container-${TAG}.tar.gz > Ankama-Launcher-Container-${TAG}.tar.gz.sha256
+gpg --local-user D33FAA16B937F3B2 --armor --detach-sign Ankama-Launcher-Container-${TAG}.tar.gz.sha256
+rm -f Ankama-Launcher-Container-${TAG}.tar.gz
+```
+
+- Upload the 3 produced files as assets in the release, re-enable the branch protection rules on the main branch for administrators and unset the `TAG` variable:
+
+```bash
+unset TAG
+```

cliff.toml

@@ -0,0 +1,97 @@
+# git-cliff ~ default configuration file
+# https://git-cliff.org/docs/configuration
+
+[remote.github]
+owner = "Antiz96"
+repo = "Ankama-Launcher-Container"
+
+[changelog]
+# template for the changelog footer
+header = """
+# Changelog\n
+All notable changes to this project will be documented in this file.\n
+"""
+# template for the changelog body
+# https://keats.github.io/tera/docs/#introduction
+body = """
+{%- macro remote_url() -%}
+  https://github.com/Antiz96/Ankama-Launcher-Container
+{%- endmacro -%}
+
+{% macro print_commit(commit) -%}
+    - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
+        {% if commit.breaking %}[**breaking**] {% endif %}\
+        {{ commit.message | upper_first }} - \
+        ([{{ commit.id | truncate(length=7, end="") }}]({{ self::remote_url() }}/commit/{{ commit.id }}))\
+        {% if commit.remote.username %} by @{{ commit.remote.username }}{%- endif -%}
+{% endmacro -%}
+
+{% if version %}\
+    ## [{{ version }}]\
+    ({{ self::remote_url() }}/releases/tag/{{ version }}) - {{ timestamp | date(format="%Y-%m-%d") }}
+{% else %}\
+    ## [unreleased]
+{% endif %}\
+
+{% for group, commits in commits | group_by(attribute="group") %}
+    ### {{ group | striptags | trim | upper_first }}
+    {% for commit in commits
+    | filter(attribute="scope")
+    | sort(attribute="scope") %}
+        {{ self::print_commit(commit=commit) }}
+    {%- endfor -%}
+    {% raw %}\n{% endraw %}\
+    {%- for commit in commits %}
+        {%- if not commit.scope -%}
+            {{ self::print_commit(commit=commit) }}
+        {% endif -%}
+    {% endfor -%}
+{% endfor %}\n
+"""
+# template for the changelog footer
+footer = """
+<!-- generated by git-cliff -->
+"""
+# remove the leading and trailing s
+trim = true
+# postprocessors
+postprocessors = [
+  { pattern = '<REPO>', replace = "https://github.com/Antiz96/Ankama-Launcher-Container" }, # replace repository URL
+]
+
+[git]
+# parse the commits based on https://www.conventionalcommits.org
+conventional_commits = true
+# filter out the commits that are not conventional
+filter_unconventional = false
+# process each line of a commit as an individual commit
+split_commits = false
+# regex for preprocessing the commit messages
+commit_preprocessors = [
+  { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/pull/${2}))" },
+]
+# regex for parsing and grouping commits
+commit_parsers = [
+  { message = "^feat", group = "<!-- 0 -->Features" },
+  { message = "^fix", group = "<!-- 1 -->Fixes" },
+  { message = "^doc", group = "<!-- 2 -->Documentation" },
+  { message = "^style", group = "<!-- 4 -->Styling" },
+  { message = "^chore\\(release\\): v", skip = true },
+  { message = "^chore", group = "<!-- 5 -->Miscellaneous" },
+]
+# protect breaking changes from being skipped due to matching a skipping commit_parser
+protect_breaking_commits = false
+# filter out the commits that are not matched by commit parsers
+filter_commits = false
+# regex for matching git tags
+# tag_pattern = "v[0-9].*"
+# regex for skipping tags
+# skip_tags = ""
+# regex for ignoring tags
+# ignore_tags = ""
+# sort the tags topologically
+topo_order = false
+# sort the commits inside sections by oldest/newest order
+sort_commits = "newest"
+# limit the number of commits included in the changelog.
+# limit_commits = 42