Skip to content

Commit cc52ec4

Browse files
committed
docs: add notice about upcoming test branch transition
Add a prominent notice to both the README and the web UI to inform users of an upcoming major change. The test branch will merge into main in the coming weeks, introducing a rebuilt app and a single combined container image. Users are advised to either migrate to the test branch's docker-compose or pin their current deployment to a specific image tag to avoid breaking changes. The UI notice includes a link to the test branch details on GitHub.
1 parent 630b35b commit cc52ec4

File tree

2 files changed

+30
-1
lines changed

2 files changed

+30
-1
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,16 @@
1010

1111
---
1212

13+
## Notice: Test branch transition
14+
15+
We’re actively developing a new test branch with a rebuilt app and a single combined container image. It will merge into `main` in the coming weeks.
16+
17+
Please start transitioning to the test-branch `docker-compose` or pin your current deployment to a specific image tag instead of `latest` to avoid breaking changes during the merge.
18+
19+
Test branch details: https://github.com/lklynet/aurral/tree/test
20+
21+
---
22+
1323
## What is Aurral?
1424

1525
Aurral is a simple web application that allows users to search for artists using the MusicBrainz database and seamlessly add them to their Lidarr music library. Think of it as an Overseerr or Jellyseerr, but specifically focused on music artists and Lidarr integration.

frontend/src/components/Layout.jsx

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { useState, useEffect } from "react";
22
import { useNavigate, useLocation } from "react-router-dom";
3-
import { Search, Menu } from "lucide-react";
3+
import { Search, Menu, Info } from "lucide-react";
44
import Sidebar from "./Sidebar";
55

66
function Layout({ children, isHealthy, lidarrConfigured, lidarrStatus }) {
@@ -55,6 +55,25 @@ function Layout({ children, isHealthy, lidarrConfigured, lidarrStatus }) {
5555
</form>
5656
</header>
5757

58+
<div className="px-4 md:px-6 pt-4">
59+
<div className="flex flex-col md:flex-row md:items-center md:justify-between gap-3 rounded-2xl border border-amber-200 bg-amber-50 text-amber-900 dark:border-amber-500/20 dark:bg-amber-900/20 dark:text-amber-200 px-4 py-3">
60+
<div className="flex items-start gap-3">
61+
<Info className="w-5 h-5 mt-0.5 text-amber-700 dark:text-amber-300" />
62+
<div className="text-sm">
63+
<span className="font-semibold">Upcoming transition:</span> The new test branch will merge into main in the coming weeks. Please migrate to its docker-compose or pin your current deployment to a specific image tag instead of latest.
64+
</div>
65+
</div>
66+
<a
67+
href="https://github.com/lklynet/aurral/tree/test"
68+
target="_blank"
69+
rel="noopener noreferrer"
70+
className="text-sm font-medium text-amber-800 hover:text-amber-900 dark:text-amber-200 dark:hover:text-amber-100 whitespace-nowrap"
71+
>
72+
View test branch
73+
</a>
74+
</div>
75+
</div>
76+
5877
<main className="flex-1 w-full max-w-[1600px] mx-auto p-4 md:p-8 lg:p-10">
5978
<div className="animate-fade-in">{children}</div>
6079
</main>

0 commit comments

Comments
 (0)