Follow Jellyfin versioning

jwueller · Jun 7, 2024 · a702f77 · a702f77
1 parent 3edb1b6
commit a702f77
Show file tree

Hide file tree

Showing 6 changed files with 89 additions and 30 deletions.
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -1,8 +1,18 @@
 <Project>
   <PropertyGroup>
-    <ProjectVersion>1.5.1.0</ProjectVersion>
-    <Version>$(ProjectVersion)</Version>
-    <AssemblyVersion>$(ProjectVersion)</AssemblyVersion>
-    <FileVersion>$(ProjectVersion)</FileVersion>
+    <PluginBuildVersion>13</PluginBuildVersion>
+  </PropertyGroup>
+  <Target Name="BuildPluginVersion" BeforeTargets="BeforeBuild">
+    <ItemGroup>
+      <JellyfinVersion Include="%(PackageVersion.Version)" Condition="%(PackageVersion.Identity) == 'Jellyfin.Controller'" />
+    </ItemGroup>
+    <PropertyGroup>
+      <PluginVersion>@(JellyfinVersion).$(PluginBuildVersion)</PluginVersion>
+    </PropertyGroup>
+  </Target>
+  <PropertyGroup>
+    <Version>$(PluginVersion)</Version>
+    <AssemblyVersion>$(PluginVersion)</AssemblyVersion>
+    <FileVersion>$(PluginVersion)</FileVersion>
   </PropertyGroup>
 </Project>
diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -0,0 +1,21 @@
+<Project>
+  <PropertyGroup>
+    <ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
+  </PropertyGroup>
+  <ItemGroup>
+    <PackageVersion Include="Jellyfin.Controller" Version="10.9.6"/>
+    <PackageVersion Include="Jellyfin.Model" Version="10.9.6"/>
+  </ItemGroup>
+  <ItemGroup>
+    <PackageVersion Include="SerilogAnalyzer" Version="0.15.0"/>
+    <PackageVersion Include="StyleCop.Analyzers" Version="1.2.0-beta.556"/>
+    <PackageVersion Include="SmartAnalyzers.MultithreadingAnalyzer" Version="1.1.31"/>
+  </ItemGroup>
+  <ItemGroup>
+    <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.10.0" />
+    <PackageVersion Include="Moq" Version="4.20.70" />
+    <PackageVersion Include="xunit" Version="2.8.1" />
+    <PackageVersion Include="xunit.runner.visualstudio" Version="2.8.1"/>
+    <PackageVersion Include="coverlet.collector" Version="6.0.2"/>
+  </ItemGroup>
+</Project>
diff --git a/JWueller.Jellyfin.OnePace.Tests/JWueller.Jellyfin.OnePace.Tests.csproj b/JWueller.Jellyfin.OnePace.Tests/JWueller.Jellyfin.OnePace.Tests.csproj
@@ -9,23 +9,23 @@
     <LangVersion>latest</LangVersion>
   </PropertyGroup>
   <ItemGroup>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.10.0" />
-    <PackageReference Include="Moq" Version="4.20.70" />
-    <PackageReference Include="xunit" Version="2.8.1" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.8.1">
+    <PackageReference Include="Microsoft.NET.Test.Sdk"/>
+    <PackageReference Include="Moq"/>
+    <PackageReference Include="xunit"/>
+    <PackageReference Include="xunit.runner.visualstudio">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
-    <PackageReference Include="coverlet.collector" Version="6.0.2">
+    <PackageReference Include="coverlet.collector">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
   </ItemGroup>
   <ItemGroup>
-    <PackageReference Include="Jellyfin.Controller" Version="10.9.6" />
-    <PackageReference Include="Jellyfin.Model" Version="10.9.6" />
+    <PackageReference Include="Jellyfin.Controller"/>
+    <PackageReference Include="Jellyfin.Model"/>
   </ItemGroup>
   <ItemGroup>
-    <ProjectReference Include="..\JWueller.Jellyfin.OnePace\JWueller.Jellyfin.OnePace.csproj" />
+    <ProjectReference Include="..\JWueller.Jellyfin.OnePace\JWueller.Jellyfin.OnePace.csproj"/>
   </ItemGroup>
-</Project>
+</Project>
diff --git a/JWueller.Jellyfin.OnePace/JWueller.Jellyfin.OnePace.csproj b/JWueller.Jellyfin.OnePace/JWueller.Jellyfin.OnePace.csproj
@@ -9,20 +9,20 @@
     <CodeAnalysisRuleSet>../jellyfin.ruleset</CodeAnalysisRuleSet>
   </PropertyGroup>
   <ItemGroup>
-    <PackageReference Include="Jellyfin.Controller" Version="10.9.6"/>
-    <PackageReference Include="Jellyfin.Model" Version="10.9.6"/>
+    <PackageReference Include="Jellyfin.Controller"/>
+    <PackageReference Include="Jellyfin.Model"/>
   </ItemGroup>
   <ItemGroup>
     <InternalsVisibleTo Include="$(AssemblyName).Tests"/>
   </ItemGroup>
   <ItemGroup>
-    <PackageReference Include="SerilogAnalyzer" Version="0.15.0" PrivateAssets="All"/>
-    <PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.556" PrivateAssets="All"/>
-    <PackageReference Include="SmartAnalyzers.MultithreadingAnalyzer" Version="1.1.31" PrivateAssets="All"/>
+    <PackageReference Include="SerilogAnalyzer" PrivateAssets="All"/>
+    <PackageReference Include="StyleCop.Analyzers" PrivateAssets="All"/>
+    <PackageReference Include="SmartAnalyzers.MultithreadingAnalyzer" PrivateAssets="All"/>
   </ItemGroup>
   <Target Name="GenerateManifest" AfterTargets="Build">
     <Exec
-      EnvironmentVariables="PROJECT_VERSION=$(ProjectVersion);CHANGELOG_PATH=$(SolutionDir)changelogs/$(ProjectVersion).md"
-      Command="yq '.version = strenv(PROJECT_VERSION) | .changelog = (load_str(strenv(CHANGELOG_PATH)) | trim)' &lt; $(SolutionDir)/meta.template.yaml &gt; $(SolutionDir)/jprm.yaml" />
+      EnvironmentVariables="PLUGIN_VERSION=$(PluginVersion);CHANGELOG_PATH=$(SolutionDir)/changelogs/$(PluginVersion).md"
+      Command="yq '.version = strenv(PLUGIN_VERSION) | .changelog = (load_str(strenv(CHANGELOG_PATH)) | trim)' &lt; $(SolutionDir)/meta.template.yaml &gt; $(SolutionDir)/jprm.yaml"/>
   </Target>
 </Project>
diff --git a/README.md b/README.md
@@ -3,12 +3,39 @@
 This [Jellyfin](https://jellyfin.org/) plugin provides metadata and cover art integration for the [One Pace](https://onepace.net/) project.
 
 
-### Series Overview
+## Troubleshooting
+
+### Arcs/seasons are not detected correctly
+
+You might be missing a series-folder. Please see the [Pitfalls](#Pitfalls) section for more details. To ensure that your folder structure is correct, please follow these steps:
+
+1. Note down the folder path for the library you configured this plugin for.
+2. Ensure that the library folder contains _one folder per series_ (e.g. `One Pace`).
+3. Ensure that the `One Pace` series folder contains _one folder per arc/season_, (e.g. `[One Pace][1-7] Romance Dawn [1080p]`).
+4. Ensure that the video files are placed _within the respective arc/season folder_.
+5. Replace all metadata for the library (see the [Outdated metadata](#Outdated-metadata) section).
+
+
+### Outdated metadata
+
+If you are experiencing issues with outdated/partial data, please try explicitly replacing all metadata. This applies to Jellyfin in general and isn't specific to this plugin.
+
+1. Press the three dots on the library.
+2. Select "Refresh metadata".
+3. Select "Replace all metadata" from the dropdown.
+4. Check "Replace existing images", if desired.
+5. Click the "Refresh" button.
+6. Wait for the scan to finish.
+
+
+## What does it look like?
+
+### Series overview
 
 ![Series Overview](docs/series.png)
 
 
-### Arc Overview
+### Arc/season overview
 
 ![Arc Overview](docs/arc.png)
 
@@ -19,7 +46,7 @@ This [Jellyfin](https://jellyfin.org/) plugin provides metadata and cover art in
 2. Install the "One Pace" plugin from the catalog
 
 
-### Configure the Library
+### Configure the library
 
 Make sure you have a library of content type "Shows". You can use an existing one or create a new one like this:
 
@@ -41,7 +68,7 @@ If the library was previously scanned, you might have to manually identify or re
 Note that the One Pace project currently doesn't have any series cover art, so you might have to either manually upload some, or enable a different provider like AniList or AniDB to fetch some for the regular One Piece series.
 
 
-## Recommended File Structure
+## Library folder structure
 
 This integration is designed to work directly with the released files from the One Pace project.
 
@@ -52,19 +79,19 @@ This integration is designed to work directly with the released files from the O
 
 ### Example
 
-```
-/media/anime/
-├── One Pace
-│   ├── [One Pace][1-7] Romance Dawn [1080p]
+```plain
+/media/anime/                                    <- library
+├── One Pace                                     <- series
+│   ├── [One Pace][1-7] Romance Dawn [1080p]     <- arc/season
 │   │   ├── [One Pace][1] Romance Dawn 01 [1080p][D767799C].mkv
 │   │   ├── [One Pace][2] Romance Dawn 02 [1080p][04A43CEF].mkv
 │   │   ├── [One Pace][3-5] Romance Dawn 03 [1080p][C7CA5080].mkv
 │   │   └── [One Pace][5-7] Romance Dawn 04 [1080p][09DD81D3].mkv
-│   ├── [One Pace][8-21] Orange Town [1080p]
+│   ├── [One Pace][8-21] Orange Town [1080p]     <- arc/season
 │   │   ├── [One Pace][11-16] Orange Town 02 [480p][3D7957D8].mkv
 │   │   ├── [One Pace][17-21] Orange Town 03 [480p][800263CF].mkv
 │   │   └── [One Pace][8-11] Orange Town 01 [480p][A2F5F372].mkv
-│   ├── [One Pace][23-41] Syrup Village [480p]
+│   ├── [One Pace][23-41] Syrup Village [480p]   <- arc/season
 │   │   ├── [One Pace][23-25] Syrup Village 01 [480p][B19F374A].mkv
 │   │   ├── [One Pace][26-27] Syrup Village 02 [480p][7EE6C65F].mkv
 │   │   ├── [One Pace][28-30] Syrup Village 03 [480p][C2C0A86A].mkv

diff --git a/changelogs/10.9.6.13.md b/changelogs/10.9.6.13.md
@@ -0,0 +1 @@
+Follow Jellyfin versioning to make compatibility obvious