README and build workflow changes

This commit is contained in:
Phin 2023-11-07 15:11:49 +05:30
parent ba0129e99a
commit b94ee58353
4 changed files with 34 additions and 14 deletions

10
.github/release-notes/v2.4.1.md vendored Normal file
View file

@ -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)

10
.github/release-notes/v2.4.2.md vendored Normal file
View file

@ -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)

View file

@ -5,8 +5,6 @@ on:
tags: tags:
- v* - v*
workflow_dispatch: workflow_dispatch:
env:
DOCKER_IMAGE_NAME: ghcr.io/${{ github.actor }}/${{ github.event.repository.name }}
jobs: jobs:
release-zip: release-zip:
runs-on: ubuntu-latest runs-on: ubuntu-latest
@ -19,21 +17,22 @@ jobs:
uses: actions/checkout@v4 uses: actions/checkout@v4
- name: Create release ZIP file - name: Create release ZIP file
run: |- run: |-
mkdir ${{ github.event.repository.name }} mv .github/release-notes ../
rm -rf .git .github .gitignore .dockerignore Dockerfile CONTRIBUTING.md pyrightconfig.json rm -rf .git .github .gitignore .dockerignore Dockerfile CONTRIBUTING.md pyrightconfig.json
mkdir ${{ github.event.repository.name }}
mv * ${{ github.event.repository.name }} || true mv * ${{ github.event.repository.name }} || true
zip -r $RELEASE_ZIP_FILENAME ${{ github.event.repository.name }} zip -r $RELEASE_ZIP_FILENAME ${{ github.event.repository.name }}
- name: Release on GitHub - name: Release on GitHub
uses: softprops/action-gh-release@de2c0eb89ae2a093876385947365aca7b0e5f844 uses: softprops/action-gh-release@de2c0eb89ae2a093876385947365aca7b0e5f844
with: with:
generate_release_notes: true
files: ${{ env.RELEASE_ZIP_FILENAME }} files: ${{ env.RELEASE_ZIP_FILENAME }}
body: |- body_path: ../release-notes/${{ github.ref_name }}.md
Docker Image: [${{ env.DOCKER_IMAGE_NAME }}](https://${{ env.DOCKER_IMAGE_NAME }})
release-docker: release-docker:
runs-on: ubuntu-latest runs-on: ubuntu-latest
permissions: permissions:
packages: write packages: write
env:
DOCKER_IMAGE_NAME: ghcr.io/${{ github.actor }}/${{ github.event.repository.name }}
steps: steps:
- name: Checkout repository - name: Checkout repository
uses: actions/checkout@v4 uses: actions/checkout@v4
@ -49,7 +48,7 @@ jobs:
uses: docker/build-push-action@v4 uses: docker/build-push-action@v4
with: with:
context: . context: .
platforms: linux/amd64,linux/arm64,linux/i386,linux/arm platforms: linux/amd64,linux/arm64,linux/386,linux/arm/v7
push: true push: true
provenance: false provenance: false
tags: ${{ env.DOCKER_IMAGE_NAME }}:${{ github.ref_name }},${{ env.DOCKER_IMAGE_NAME }}:latest tags: ${{ env.DOCKER_IMAGE_NAME }}:${{ github.ref_name }},${{ env.DOCKER_IMAGE_NAME }}:latest

View file

@ -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) [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 ### Volumes
Mount a directory for persistent data (config file, cache file and log file) at `/app/data`. 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 ### Example
``` ```
docker run \ 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
--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
``` ```
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. 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.