Skip to content

Commit 27f0797

Browse files
refactor(dashboard): align terminology with other sections (#42354)
* refactor(dependency-dashboard): align terminology with other sections. Signed-off-by: Adam Setch <adam.setch@outlook.com> * Apply suggestion from @RahulGautamSingh Co-authored-by: RahulGautamSingh <rahultesnik@gmail.com> * test: update expectations Signed-off-by: Adam Setch <adam.setch@outlook.com> --------- Signed-off-by: Adam Setch <adam.setch@outlook.com> Co-authored-by: RahulGautamSingh <rahultesnik@gmail.com>
1 parent e33aa4c commit 27f0797

2 files changed

Lines changed: 34 additions & 10 deletions

File tree

lib/workers/repository/dependency-dashboard.spec.ts

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1486,7 +1486,7 @@ None detected
14861486
);
14871487
expect(platform.ensureIssue).toHaveBeenCalledTimes(1);
14881488
expect(platform.ensureIssue.mock.calls[0][0].body).toInclude(
1489-
'These dependencies are either deprecated or have replacements available',
1489+
'The following dependencies are either deprecated or have replacements available.',
14901490
);
14911491
expect(platform.ensureIssue.mock.calls[0][0].body).toInclude(
14921492
'| npm | [cookie-parser](https://redirect.github.com/expressjs/cookie-parser) | ![Unavailable]',
@@ -1970,6 +1970,13 @@ None detected
19701970

19711971
const result = dependencyDashboard.getAbandonedPackagesMd(packageFiles);
19721972

1973+
expect(result).toContain('## Abandoned Dependencies');
1974+
expect(result).toContain(
1975+
'The following dependencies have not received updates for an extended period and may be unmaintained.',
1976+
);
1977+
expect(result).toContain(
1978+
'<summary>View abandoned dependencies (1)</summary>',
1979+
);
19731980
expect(result).toContain('> ℹ️ **Note**');
19741981
expect(result).toContain('| Datasource | Package | Last Updated |');
19751982
expect(result).toContain('| npm | `abandoned-pkg` | `2020-05-15` |');
@@ -2012,6 +2019,15 @@ None detected
20122019

20132020
const result = dependencyDashboard.getAbandonedPackagesMd(packageFiles);
20142021

2022+
expect(result).toContain('## Abandoned Dependencies');
2023+
expect(result).toContain(
2024+
'The following dependencies have not received updates for an extended period and may be unmaintained.',
2025+
);
2026+
expect(result).toContain(
2027+
'<summary>View abandoned dependencies (3)</summary>',
2028+
);
2029+
expect(result).toContain('> ℹ️ **Note**');
2030+
expect(result).toContain('| Datasource | Package | Last Updated |');
20152031
expect(result).toContain('| gradle | `org.example:lib` | `2019-07-22` |');
20162032
expect(result).toContain('| npm | `pkg1` | `2021-01-10` |');
20172033
expect(result).toContain('| npm | `pkg3` | `2020-11-05` |');
@@ -2037,6 +2053,15 @@ None detected
20372053

20382054
const result = dependencyDashboard.getAbandonedPackagesMd(packageFiles);
20392055

2056+
expect(result).toContain('## Abandoned Dependencies');
2057+
expect(result).toContain(
2058+
'The following dependencies have not received updates for an extended period and may be unmaintained.',
2059+
);
2060+
expect(result).toContain(
2061+
'<summary>View abandoned dependencies (2)</summary>',
2062+
);
2063+
expect(result).toContain('> ℹ️ **Note**');
2064+
expect(result).toContain('| Datasource | Package | Last Updated |');
20402065
expect(result).toContain('| npm | `pkg-with-date` | `2021-03-17` |');
20412066
expect(result).toContain('| npm | `pkg-no-date` | `unknown` |');
20422067
});

lib/workers/repository/dependency-dashboard.ts

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -455,7 +455,7 @@ export async function ensureDependencyDashboard(
455455
issueBody += '## Deprecations / Replacements\n';
456456
issueBody += emojify('> :warning: **Warning**\n> \n');
457457
issueBody +=
458-
'These dependencies are either deprecated or have replacements available:\n\n';
458+
'The following dependencies are either deprecated or have replacements available.\n\n';
459459
issueBody += '| Datasource | Package | Replacement PR? |\n';
460460
issueBody += '|------------|------|--------------|\n';
461461
for (const manager of Object.keys(deprecatedPackages).sort()) {
@@ -702,20 +702,19 @@ export function getAbandonedPackagesMd(
702702
return '';
703703
}
704704

705-
let abandonedMd = emojify(
706-
'## Abandoned Dependencies\n\n> :information_source: **Note**\n> \n',
707-
);
705+
let abandonedMd = '## Abandoned Dependencies\n\n';
706+
abandonedMd +=
707+
'The following dependencies have not received updates for an extended period and may be unmaintained.\n\n';
708+
709+
abandonedMd += '<details>\n';
710+
abandonedMd += `<summary>View abandoned dependencies (${abandonedCount})</summary>\n\n`;
708711

712+
abandonedMd += emojify('> :information_source: **Note**\n> \n');
709713
abandonedMd +=
710714
'Packages are marked as abandoned when they exceed the [`abandonmentThreshold`](https://docs.renovatebot.com/configuration-options/#abandonmentthreshold) since their last release. ';
711715
abandonedMd +=
712716
'Unlike deprecated packages with official notices, abandonment is detected by release inactivity.\n> \n';
713717

714-
abandonedMd +=
715-
'> These dependencies have not received updates for an extended period and may be unmaintained:\n\n';
716-
717-
abandonedMd += '<details>\n';
718-
abandonedMd += `<summary>View abandoned dependencies (${abandonedCount})</summary>\n\n`;
719718
abandonedMd += '| Datasource | Package | Last Updated |\n';
720719
abandonedMd += '|------------|------|-------------|\n';
721720

0 commit comments

Comments
 (0)