Robert Dailey
2 years ago
commit
3c1ae692f4
@ -0,0 +1,54 @@
|
||||
The Migration System allows Recyclarr to attempt certain automatic actions for the user. These
|
||||
actions, referred to as Migration Steps, are usually in response to certain changes between releases
|
||||
of Recyclarr (mostly major releases, which represent breaking changes). The overall goal of this
|
||||
system is to reduce the amount of manual action a user must take.
|
||||
|
||||
## Behavior
|
||||
|
||||
1. When Recyclarr is executed, it first runs through all of the Migration Steps in a specific,
|
||||
pre-determined order.
|
||||
1. Each Migration Step is checked if it needs to run or not.
|
||||
- If it needs to run, its actions are performed immediately.
|
||||
- Otherwise, it is skipped and the next Migration Step is processed.
|
||||
|
||||
Migration Steps can fail. When this happens, instructions are provided to the user on how to recover
|
||||
and/or perform those steps manually. Regardless of the reason, Recyclarr will immediately exit and
|
||||
cannot proceed until the advice output during the previous execution is followed.
|
||||
|
||||
## Failure & Recovery
|
||||
|
||||
When a Migration Step fails, processing of further steps is halted and the program exits. The
|
||||
failure also results in diagnostic information and remediation steps being printed to the console:
|
||||
|
||||
- A description of the Migration Step that failed. This is usually a description of what the step
|
||||
was trying to do.
|
||||
- A failure reason. Explains why the step failed and could not be processed.
|
||||
- Remediation steps. One or more ways to solve the problem. Will likely either ask you to perform
|
||||
the steps by hand or take some action to allow the migration step to succeed the next time
|
||||
Recyclarr is executed.
|
||||
|
||||
## Current Migration Steps
|
||||
|
||||
The list below describes the migration steps that are performed today, under what conditions they
|
||||
will be executed, and reasons why they might fail. Most of this information is already printed in
|
||||
real time by Recyclarr in response to failures.
|
||||
|
||||
### Rename app data directory from `trash-updater` to `recyclarr`
|
||||
|
||||
- **When**: `v2.0`
|
||||
- **What**: Renames your `trash-updater` app data directory to `recyclarr` automatically.
|
||||
- **Why**: The application was renamed from Trash Updater to Recyclarr. Thus, the app data directory
|
||||
name needed to follow suit.
|
||||
- **How can it fail?**
|
||||
- The `recyclarr` directory already exists.
|
||||
- User lacks sufficient permissions on the filesystem.
|
||||
|
||||
### Rename default `trash.yml` file to `recyclarr.yml`
|
||||
|
||||
- **When**: `v2.0`
|
||||
- **What**: Renames your `trash.yml` file to `recyclarr.yml` automatically.
|
||||
- **Why**: The application was renamed from Trash Updater to Recyclarr. Thus, the app data directory
|
||||
name needed to follow suit.
|
||||
- **How can it fail?**
|
||||
- The `recyclarr.yml` file already exists.
|
||||
- User lacks sufficient permissions on the filesystem.
|
||||
@ -0,0 +1,91 @@
|
||||
# Version 2.0
|
||||
|
||||
This version introduces changes to the way Sonarr Release Profiles are specified in your YAML
|
||||
configuration (`trash.yml`). As such, changes are required to your YAML to avoid errors. First,
|
||||
visit the "Series Types" section to replace the `type` attribute with `trash_ids` as needed. Then
|
||||
check out the "Term Filters" section to see about removing the `include_optionals` property.
|
||||
|
||||
## Series Types
|
||||
|
||||
The `type` property under `release_profiles` has been removed. Replaced by a new `trash_ids`
|
||||
property.
|
||||
|
||||
### Drop-In Replacement for Series
|
||||
|
||||
For `series`, replace this:
|
||||
|
||||
```yml
|
||||
release_profiles:
|
||||
- type: series
|
||||
```
|
||||
|
||||
With this (or you can customize it if you want less):
|
||||
|
||||
```yml
|
||||
release_profiles:
|
||||
- trash_ids:
|
||||
- EBC725268D687D588A20CBC5F97E538B # Low Quality Groups
|
||||
- 1B018E0C53EC825085DD911102E2CA36 # Release Sources (Streaming Service)
|
||||
- 71899E6C303A07AF0E4746EFF9873532 # P2P Groups + Repack/Proper
|
||||
```
|
||||
|
||||
### Drop-In Replacement for Anime
|
||||
|
||||
For `series`, replace this:
|
||||
|
||||
```yml
|
||||
release_profiles:
|
||||
- type: anime
|
||||
```
|
||||
|
||||
With this (or you can customize it if you want less):
|
||||
|
||||
```yml
|
||||
release_profiles:
|
||||
- trash_ids:
|
||||
- d428eda85af1df8904b4bbe4fc2f537c # Anime - First release profile
|
||||
- 6cd9e10bb5bb4c63d2d7cd3279924c7b # Anime - Second release profile
|
||||
```
|
||||
|
||||
## Term Filters
|
||||
|
||||
The following changes apply to YAML under the `filter` property.
|
||||
|
||||
- Property `include_optional` removed.
|
||||
- `include` and `exclude` properties added to explicitly choose terms to include or exclude,
|
||||
respectively.
|
||||
|
||||
### Replacement Examples
|
||||
|
||||
If you are coming from YAML like this:
|
||||
|
||||
```yml
|
||||
release_profiles:
|
||||
- trash_ids: [EBC725268D687D588A20CBC5F97E538B]
|
||||
strict_negative_scores: false
|
||||
filter:
|
||||
include_optional: true
|
||||
tags:
|
||||
- tv
|
||||
```
|
||||
|
||||
Simply remove the `include_optional` property above, to get this:
|
||||
|
||||
```yml
|
||||
release_profiles:
|
||||
- trash_ids: [EBC725268D687D588A20CBC5F97E538B]
|
||||
strict_negative_scores: false
|
||||
tags:
|
||||
- tv
|
||||
```
|
||||
|
||||
## Other Notes
|
||||
|
||||
- In this release, since you now have the ability to specifically include optionals that you want, I
|
||||
recommend visiting the [Configuration Reference] and learning more about the `include` and
|
||||
`exclude` filter lists.
|
||||
- Migration steps have been added. See the `v2.0` migration steps documented on the [Migration
|
||||
System] page.
|
||||
|
||||
[Configuration Reference]: https://github.com/rcdailey/recyclarr/wiki/Configuration-Reference
|
||||
[Migration System]: https://github.com/rcdailey/recyclarr/wiki/Migration-System
|
||||
Loading…
Reference in new issue