Skip to content

Commit

Permalink
Add warnings in release and migration notes
Browse files Browse the repository at this point in the history
  • Loading branch information
WithoutPants committed Jul 13, 2022
1 parent 84c32be commit 2fd2713
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 8 deletions.
20 changes: 18 additions & 2 deletions ui/v2.5/src/docs/en/Changelog/v0170.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
### **Warning:** this is an experimental release. Use at your own risk!

Please ensure you back up your **entire** stash system before using this build. This build should be considered experimental.

After migrating, please run a scan on your entire library to populate missing data, and to ingest identical files which were previously ignored.

Please report all issues to the following Github issue: https://github.com/stashapp/stash/issues/2737

### 💥 Known issues
* import/export functionality is currently disabled. Needs further design.
* missing covers are not currently regenerated. Need to consider further, especially around scene cover redesign.
* deleting galleries is currently slow.
* Don't include file extension as part of the title scan flag is not supported.
* Set name, date, details from embedded file metadata scan flag is not supported.

### ✨ New Features
* Added release notes dialog. ([#](https://github.com/stashapp/stash/pull/))
* Added support for identical files. Identical files are assigned to the same scene/gallery/image and can be viewed in File Info. ([#2676](https://github.com/stashapp/stash/pull/2676))
* Added release notes dialog. ([#2726](https://github.com/stashapp/stash/pull/2726))

### 🎨 Improvements
* Moved Changelogs to Settings page. ([#](https://github.com/stashapp/stash/pull/))
* Moved Changelogs to Settings page. ([#2726](https://github.com/stashapp/stash/pull/2726))
7 changes: 7 additions & 0 deletions ui/v2.5/src/docs/en/MigrationNotes/32.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
### **Warning:** this is an experimental release. Use at your own risk!

Please ensure you back up your **entire** stash system before using this build. This build should be considered experimental.

This migration significantly changes the way that stash stores information about your files. This migration is not reversible.

After migrating, please run a scan on your entire library to populate missing data, and to ingest identical files which were previously ignored.
10 changes: 4 additions & 6 deletions ui/v2.5/src/docs/en/MigrationNotes/index.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
// import migration32 from "./32.md";
import migration32 from "./32.md";

// type Module = typeof migration32;
type Module = typeof migration32;

// replace any with module once we add migration notes
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export const migrationNotes: Record<number, any> = {
// 32: migration31,
export const migrationNotes: Record<number, Module> = {
32: migration32,
};
17 changes: 17 additions & 0 deletions ui/v2.5/src/docs/en/ReleaseNotes/v0170.md
Original file line number Diff line number Diff line change
@@ -1 +1,18 @@
### **Warning:** this is an experimental release. Use at your own risk!

Please ensure you back up your **entire** stash system before using this build. This build should be considered experimental.

After migrating, please run a scan on your entire library to populate missing data, and to ingest identical files which were previously ignored.

Please report all issues to the following Github issue: https://github.com/stashapp/stash/issues/2737

### 💥 Known issues
* import/export functionality is currently disabled. Needs further design.
* missing covers are not currently regenerated. Need to consider further, especially around scene cover redesign.
* deleting galleries is currently slow.
* Don't include file extension as part of the title scan flag is not supported.
* Set name, date, details from embedded file metadata scan flag is not supported.

### Other changes:

* Changelog has been moved from the stats page to a section in the Settings page.

0 comments on commit 2fd2713

Please sign in to comment.