From b94ee5835335f7072054d8faf3b4a3ea612f58c5 Mon Sep 17 00:00:00 2001
From: Phin <59180111+phin05@users.noreply.github.com>
Date: Tue, 7 Nov 2023 15:11:49 +0530
Subject: [PATCH] README and build workflow changes

---
 .github/release-notes/v2.4.1.md | 10 ++++++++++
 .github/release-notes/v2.4.2.md | 10 ++++++++++
 .github/workflows/release.yml   | 13 ++++++-------
 README.md                       | 15 ++++++++-------
 4 files changed, 34 insertions(+), 14 deletions(-)
 create mode 100644 .github/release-notes/v2.4.1.md
 create mode 100644 .github/release-notes/v2.4.2.md

diff --git a/.github/release-notes/v2.4.1.md b/.github/release-notes/v2.4.1.md
new file mode 100644
index 0000000..81c8398
--- /dev/null
+++ b/.github/release-notes/v2.4.1.md
@@ -0,0 +1,10 @@
+### Release Notes
+
+* Missing dependencies will now be automatically installed through pip
+* Added support for YAML config file (#71)
+* Updated build workflow to build Docker images for `linux/arm/v7` platform (#70)
+
+### Installation Instructions
+
+* [Regular](https://github.com/phin05/discord-rich-presence-plex/blob/v2.4.1/README.md#installation)
+* [Docker](https://github.com/phin05/discord-rich-presence-plex/blob/v2.4.1/README.md#run-with-docker)
diff --git a/.github/release-notes/v2.4.2.md b/.github/release-notes/v2.4.2.md
new file mode 100644
index 0000000..0f04358
--- /dev/null
+++ b/.github/release-notes/v2.4.2.md
@@ -0,0 +1,10 @@
+### Release Notes
+
+* Poster images will now be converted to plain JPEG before being uploaded (#42, #62)
+* Added configuration property `ipcPipeNumber` (#21, #30, #63)
+* Updated build workflow to build Docker images for `linux/386` platform
+
+### Installation Instructions
+
+* [Regular](https://github.com/phin05/discord-rich-presence-plex/blob/v2.4.2/README.md#installation)
+* [Docker](https://github.com/phin05/discord-rich-presence-plex/blob/v2.4.2/README.md#run-with-docker)
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index 37d6915..121ca28 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -5,8 +5,6 @@ on:
     tags:
       - v*
   workflow_dispatch:
-env:
-  DOCKER_IMAGE_NAME: ghcr.io/${{ github.actor }}/${{ github.event.repository.name }}
 jobs:
   release-zip:
     runs-on: ubuntu-latest
@@ -19,21 +17,22 @@ jobs:
         uses: actions/checkout@v4
       - name: Create release ZIP file
         run: |-
-          mkdir ${{ github.event.repository.name }}
+          mv .github/release-notes ../
           rm -rf .git .github .gitignore .dockerignore Dockerfile CONTRIBUTING.md pyrightconfig.json
+          mkdir ${{ github.event.repository.name }}
           mv * ${{ github.event.repository.name }} || true
           zip -r $RELEASE_ZIP_FILENAME ${{ github.event.repository.name }}
       - name: Release on GitHub
         uses: softprops/action-gh-release@de2c0eb89ae2a093876385947365aca7b0e5f844
         with:
-          generate_release_notes: true
           files: ${{ env.RELEASE_ZIP_FILENAME }}
-          body: |-
-            Docker Image: [${{ env.DOCKER_IMAGE_NAME }}](https://${{ env.DOCKER_IMAGE_NAME }})
+          body_path: ../release-notes/${{ github.ref_name }}.md
   release-docker:
     runs-on: ubuntu-latest
     permissions:
       packages: write
+    env:
+      DOCKER_IMAGE_NAME: ghcr.io/${{ github.actor }}/${{ github.event.repository.name }}
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -49,7 +48,7 @@ jobs:
         uses: docker/build-push-action@v4
         with:
           context: .
-          platforms: linux/amd64,linux/arm64,linux/i386,linux/arm
+          platforms: linux/amd64,linux/arm64,linux/386,linux/arm/v7
           push: true
           provenance: false
           tags: ${{ env.DOCKER_IMAGE_NAME }}:${{ github.ref_name }},${{ env.DOCKER_IMAGE_NAME }}:latest
diff --git a/README.md b/README.md
index 5f485b9..c2e0edf 100644
--- a/README.md
+++ b/README.md
@@ -173,6 +173,13 @@ The "Display current activity as a status message" setting must be enabled in Di
 
 [ghcr.io/phin05/discord-rich-presence-plex](https://ghcr.io/phin05/discord-rich-presence-plex)
 
+Images are available for the following platforms:
+
+* linux/amd64
+* linux/arm64
+* linux/386
+* linux/arm/v7
+
 ### Volumes
 
 Mount a directory for persistent data (config file, cache file and log file) at `/app/data`.
@@ -191,13 +198,7 @@ For example, if the environment variable `XDG_RUNTIME_DIR` is set to `/run/user/
 ### Example
 
 ```
-docker run \
-  --volume ./data:/app/data \
-  --volume /run/user/1000:/run/app:ro \
-  --detach \
-  --restart unless-stopped \
-  --name discord-rich-presence-plex \
-  ghcr.io/phin05/discord-rich-presence-plex:latest
+docker run -v ./data:/app/data -v /run/user/1000:/run/app:ro -d --restart unless-stopped --name drpp ghcr.io/phin05/discord-rich-presence-plex:latest
 ```
 
 If you're running the container for the first time (when there are no users in the config), make sure that the `PLEX_SERVER_NAME` environment variable is set (see the [environment variables](#configuration---environment-variables) section above), and check the container logs for the authentication link.