4.1.1 (#528)

* 4.1.1-develop * Updated docs * chore(docs): Sync wiki to docs [skip-cd] * chore(docs): Sync wiki to docs [skip-cd] * Fixes #522 * (docs): automatically add Supported Version to README (#521) * (docs): add version for qbit / qbit api to readme (#523) (cherry picked from commit 37e560f) * (docs): automate supported versions for readme (docs): readme updates (chore): fix pre-commit increase_version * (chore): automate supported version updates --------- Co-authored-by: bakerboy448 <mailto:[email protected]> * Adds pre-commit hook to update-readme-version * Bump actions/setup-python from 4 to 5 (#525) Bumps [actions/setup-python](https://github.com/actions/setup-python) from 4 to 5. - [Release notes](https://github.com/actions/setup-python/releases) - [Commits](actions/setup-python@v4...v5) --- updated-dependencies: - dependency-name: actions/setup-python dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump actions/checkout from 3 to 4 (#526) Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 4. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](actions/checkout@v3...v4) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump peter-evans/create-pull-request from 4 to 6 (#527) Bumps [peter-evans/create-pull-request](https://github.com/peter-evans/create-pull-request) from 4 to 6. - [Release notes](https://github.com/peter-evans/create-pull-request/releases) - [Commits](peter-evans/create-pull-request@v4...v6) --- updated-dependencies: - dependency-name: peter-evans/create-pull-request dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Dependabot to auto-update qbittorrent-api on master * 4.1.1 * fixes pre-commit on github actions --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: Actionbot <[email protected]> Co-authored-by: bakerboy448 <[email protected]> Co-authored-by: bakerboy448 <mailto:[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
StuffAnThings · Apr 8, 2024 · 2723115 · 2723115
1 parent 37e560f
commit 2723115
Show file tree

Hide file tree

Showing 23 changed files with 1,229 additions and 26 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -12,6 +12,15 @@ updates:
     target-branch: "develop"
     assignees:
       - "bobokun"
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    target-branch: "master"
+    assignees:
+      - "bobokun"
+    allow:
+      - dependency-name: "qbittorrent-api"
   - package-ecosystem: github-actions
     directory: '/'
     schedule:

diff --git a/.github/workflows/update-supported-versions.yml b/.github/workflows/update-supported-versions.yml
@@ -0,0 +1,50 @@
+name: Update Supported Versions
+
+on:
+  push:
+    branches:
+      - master
+      - develop
+    paths:
+      - "requirements.txt"
+  workflow_dispatch:
+    inputs:
+      targetBranch:
+        description: "Branch to run the script on (default: develop)"
+        required: false
+        default: "develop"
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  update-versions:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.inputs.targetBranch || github.ref_name }}
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Install dependencies from requirements.txt
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
+      - name: Run update script
+        run: python scripts/update-readme-version.py ${{ github.event.inputs.targetBranch || github.ref_name }}
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v6
+        with:
+          commit-message: Update SUPPORTED_VERSIONS.json
+          title: "Update SUPPORTED_VERSIONS.json for ${{ github.event.inputs.targetBranch || github.ref_name }}"
+          branch: update-supported-versions-${{ github.event.inputs.targetBranch || github.ref_name }}
+          base: develop
+          body: "This PR updates the SUPPORTED_VERSIONS.json to reflect new versions."
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -61,3 +61,11 @@ repos:
         language: script
         pass_filenames: false
         stages: [commit]
+  - repo: local
+    hooks:
+      - id: update-readme-version
+        name: Update readme version
+        entry: ./scripts/pre-commit/update-readme-version.sh
+        language: script
+        pass_filenames: false
+        stages: [commit]
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,17 +1,12 @@
-# Requirements Updated
-- qbittorrent-api==2024.3.60
-- GitPython==3.1.43
-
-# New Features
-- Added Group Uplaod Speed to share limits config to apply upload speed limits at a group level. Closes [#494](https://github.com/StuffAnThings/qbit_manage/issues/494)
-- Added Force Retag All in config settings to force retagging of all torrents. Closes [#513](https://github.com/StuffAnThings/qbit_manage/issues/513)
-- Added `--mover-old` command in mover script for users that use Mover Tuning Plugin
-
+# New Updates
+- Added docs to qbit-manage repo (under docs folder)
+- Bi-directional wiki sync
+- Automatically update supported version to README
+- Pre-commit hooks to update readme version
+- Dependabot to automatically update qbittorrent-api on master
 
 # Bug Fixes
-- Fixes [#501](https://github.com/StuffAnThings/qbit_manage/issues/501)
-- Adds additional error checking for invalid share limits defined in config
-- Minor bug fixes in share limits
+- fixes [#522](https://github.com/StuffAnThings/qbit_manage/issues/522)
 
-Special thanks to @walkerp1 for their contributions!
-**Full Changelog**: https://github.com/StuffAnThings/qbit_manage/compare/v4.0.9...v4.1.0
+Special thanks to @bakerboy448 for their contributions!
+**Full Changelog**: https://github.com/StuffAnThings/qbit_manage/compare/v4.1.0...v4.1.1
diff --git a/README.md b/README.md
@@ -1,4 +1,6 @@
-# <img src="qbm_logo.png" width="75"> qBit Manage
+# Qbittorrent Manage
+
+![qBit Manage](qbm_logo.png =75x)
 
 [![GitHub release (latest by date)](https://img.shields.io/github/v/release/StuffAnThings/qbit_manage?style=plastic)](https://github.com/StuffAnThings/qbit_manage/releases)
 [![GitHub commits since latest release (by SemVer)](https://img.shields.io/github/commits-since/StuffAnThings/qbit_manage/latest/develop?label=Commits%20in%20Develop&style=plastic)](https://github.com/StuffAnThings/qbit_manage/tree/develop)
@@ -27,29 +29,34 @@ This is a program used to manage your qBittorrent instance such as:
 
 ### Master
 
-![master - qbittorrent-api version](https://img.shields.io/badge/qbittorrent--api-2024.3.60-blue)
-![master - Supported qBittorrent version](https://img.shields.io/badge/qBittorrent-v4.6.4-brightgreen)
+![master - qBittorrent version](https://img.shields.io/badge/dynamic/json?label=master%20-%20qBittorrent&query=master.qbit&url=https%3A%2F%2Fraw.githubusercontent.com%2FStuffAnThings%2Fqbit_manage%2Fdevelop%2FSUPPORTED_VERSIONS.json&color=brightgreen)
+
+![master - qbittorrent-api version](https://img.shields.io/badge/dynamic/json?label=master%20-%20qbittorrent-api&query=master.qbitapi&url=https%3A%2F%2Fraw.githubusercontent.com%2FStuffAnThings%2Fqbit_manage%2Fdevelop%2FSUPPORTED_VERSIONS.json&color=blue)
 
 ### Develop
 
-![develop - qbittorrent-api version](https://img.shields.io/badge/qbittorrent--api-2024.3.60-blue)
-![develop - Supported qBittorrent version](https://img.shields.io/badge/qBittorrent-v4.6.4-brightgreen)
+![develop - qBittorrent version](https://img.shields.io/badge/dynamic/json?label=develop%20-%20qBittorrent&query=develop.qbit&url=https%3A%2F%2Fraw.githubusercontent.com%2FStuffAnThings%2Fqbit_manage%2Fdevelop%2FSUPPORTED_VERSIONS.json&color=brightgreen)
+
+![develop - qbittorrent-api version](https://img.shields.io/badge/dynamic/json?label=develop%20-%20qbittorrent-api&query=develop.qbitapi&url=https%3A%2F%2Fraw.githubusercontent.com%2FStuffAnThings%2Fqbit_manage%2Fdevelop%2FSUPPORTED_VERSIONS.json&color=blue)
 
 ## Getting Started
 
 Check out the [wiki](https://github.com/StuffAnThings/qbit_manage/wiki) for installation help
 
-1. Install qbit_manage either by installing Python 3.8.1+ on the localhost and following the [Local Installation](https://github.com/StuffAnThings/qbit_manage/wiki/Local-Installations) Guide or by installing Docker and following the [Docker Installation](https://github.com/StuffAnThings/qbit_manage/wiki/Docker-Installation) Guide or the [unRAID Installation](https://github.com/StuffAnThings/qbit_manage/wiki/Unraid-Installation) Guide.<br>
-2. Once installed, you have to [set up your Configuration](https://github.com/StuffAnThings/qbit_manage/wiki/Config-Setup) by create a [Configuration File](https://github.com/StuffAnThings/qbit_manage/blob/master/config/config.yml.sample) filled with all your values to connect to your qBittorrent instance.
-3. Please refer to the list of [Commands](https://github.com/StuffAnThings/qbit_manage/wiki/Commands) that can be used with this tool.
+1. Install qbit_manage either by installing Python 3.8.1+ on the localhost and following the [Local Installation](https://github.com/StuffAnThings/qbit_manage/wiki/Local-Installations) Guide or by installing Docker and following the [Docker Installation](https://github.com/StuffAnThings/qbit_manage/wiki/Docker-Installation) Guide or the [unRAID Installation](https://github.com/StuffAnThings/qbit_manage/wiki/Unraid-Installation) Guide.
+1. Once installed, you have to [set up your Configuration](https://github.com/StuffAnThings/qbit_manage/wiki/Config-Setup) by create a [Configuration File](https://github.com/StuffAnThings/qbit_manage/blob/master/config/config.yml.sample) filled with all your values to connect to your qBittorrent instance.
+1. Please refer to the list of [Commands](https://github.com/StuffAnThings/qbit_manage/wiki/Commands) that can be used with this tool.
 
 ## Usage
+
 To run the script in an interactive terminal with a list of possible commands run:
+
 ```bash
 python qbit_manage.py -h
 ```
 
 ## Support
+
 * If you have any questions or require support please join the [Notifiarr Discord](https://discord.com/invite/AURf8Yz) and post your question under the `qbit-manage` channel.
 * If you're getting an Error or have an Enhancement post in the [Issues](https://github.com/StuffAnThings/qbit_manage/issues/new).
 * If you have a configuration question post in the [Discussions](https://github.com/StuffAnThings/qbit_manage/discussions/new).

diff --git a/SUPPORTED_VERSIONS.json b/SUPPORTED_VERSIONS.json
@@ -0,0 +1,10 @@
+{
+    "master": {
+        "qbit": "v4.6.4",
+        "qbitapi": "2024.3.60"
+    },
+    "develop": {
+        "qbit": "v4.6.4",
+        "qbitapi": "2024.3.60"
+    }
+}
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-4.1.0
+4.1.1
diff --git a/config/config.yml.sample b/config/config.yml.sample
@@ -200,7 +200,7 @@ share_limits:
     last_active: 43200
     # <OPTIONAL> Limit Upload Speed <int>: Will limit the upload speed KiB/s (KiloBytes/second) (`-1` : No Limit)
     limit_upload_speed: 0
-    # <OPTIONAL> Enable Group Upload Speed <bool>: Upload speed limits are applied at the group level. This will take limit_upload_speed defined and divide it equally among the number of torrents for the group.
+    # <OPTIONAL> Enable Group Upload Speed <bool>: Upload speed limits are applied at the group level. This will take limit_upload_speed defined and divide it equally among the number of torrents in the group.
     enable_group_upload_speed: false
     # <OPTIONAL> cleanup <bool>: WARNING!! Setting this as true Will remove and delete contents of any torrents that satisfies the share limits (max time OR max ratio)
     cleanup: false