Drop some release sections

This commit is contained in:
shamoon committed 2026-11-18 08:37:36 -08:00
1 parent fb4e644df7
commit a1a2eb5b36
3 files changed
+56 -4

No files matched your search

@@ -1,3 +1,6 @@
:host ::ng-deep .release-notes-body > h2 {
display: none !important;
:host ::ng-deep .release-notes-body > h3 {
font-size: 1rem;
font-weight: 600;
margin-top: 1rem;
margin-bottom: 0.5rem;
}
@@ -8,7 +8,10 @@ import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'
import { SETTINGS_KEYS } from 'src/app/data/ui-settings'
import { SettingsService } from 'src/app/services/settings.service'
import { environment } from 'src/environments/environment'
import { ReleaseNotesDialogComponent } from './release-notes-dialog.component'
import {
cleanReleaseBody,
ReleaseNotesDialogComponent,
} from './release-notes-dialog.component'
describe('ReleaseNotesDialogComponent', () => {
let component: ReleaseNotesDialogComponent
@@ -70,6 +73,33 @@ describe('ReleaseNotesDialogComponent', () => {
expect(text).not.toContain('(github.com)')
})
it('should drop the duplicate All App Changes section and details markup', () => {
const body = [
'## paperless-ngx 3.5.1',
'### Bug Fixes',
'- Fix: a thing',
'### Dependencies',
'<details>',
'<summary>1 change</summary>',
'',
'- Chore(deps): bump a thing',
'</details>',
'### All App Changes',
'<details>',
'<summary>2 changes</summary>',
'',
'- Fix: a thing',
'- Chore(deps): bump a thing',
'</details>',
].join('\r\n')
const cleaned = cleanReleaseBody(body)
expect(cleaned).toContain('### Dependencies')
expect(cleaned).toContain('- Chore(deps): bump a thing')
expect(cleaned).not.toContain('All App Changes')
expect(cleaned).not.toContain('details>')
expect(cleaned).not.toContain('summary>')
})
it('should show a message if release notes could not be loaded', () => {
create(true)
component.load(null)
@@ -12,6 +12,20 @@ import { SettingsService } from 'src/app/services/settings.service'
const RELEASES_URL = 'https://github.com/paperless-ngx/paperless-ngx/releases'
const RELEASE_TITLE = /^\s*##\s+paperless-ngx[^\n]*\n+/i
const ALL_CHANGES_SECTION = /^###\s+All App Changes\s*$[\s\S]*/im
const DETAILS_MARKUP = /^\s*(<\/?details>|<summary>.*<\/summary>)\s*$/gim
/**
* Drops the "## paperless-ngx x.y.z" title, the "All App Changes"
* section and `<details>` / `<summary>` wrappers.
*/
export function cleanReleaseBody(body: string): string {
body = body.replace(RELEASE_TITLE, '')
body = body.replace(ALL_CHANGES_SECTION, '')
return body.replace(DETAILS_MARKUP, '').trim()
}
@Component({
selector: 'pngx-release-notes-dialog',
templateUrl: './release-notes-dialog.component.html',
@@ -49,7 +63,12 @@ export class ReleaseNotesDialogComponent {
.pipe(first())
.subscribe({
next: (notes) => {
this.releases.set(notes.releases)
this.releases.set(
notes.releases.map((release) => ({
...release,
body: cleanReleaseBody(release.body),
}))
)
this.loading.set(false)
},
error: () => {