-
Notifications
You must be signed in to change notification settings - Fork 45
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve build scan badge readability with long tasks (#200)
Improve readability of build scan when requested tasks is very long, as agreed in #175. HTML diff for each case of job summary is clearer in cd62d9c. - Ensure a minimum size for the badge, at least the size of "Build scan®", by preventing a line break with ` ` - Reduce the size of the badge by tweaking the inner text Also fix a typo in the build shell script.
- Loading branch information
Showing
3 changed files
with
214 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,177 @@ | ||
| import { BuildResult } from '../../src/build-results' | ||
| import { renderSummaryTable } from '../../src/job-summary' | ||
| import dedent from 'dedent' | ||
|
|
||
|
|
||
| const successfulHelpBuild: BuildResult = { | ||
| rootProjectName: 'root', | ||
| rootProjectDir: '/', | ||
| requestedTasks: 'help', | ||
| gradleVersion: '8.0', | ||
| gradleHomeDir: '/opt/gradle', | ||
| buildFailed: false, | ||
| buildScanUri: 'https://scans.gradle.com/s/abc123', | ||
| buildScanFailed: false | ||
| } | ||
|
|
||
| const failedHelpBuild: BuildResult = { | ||
| ...successfulHelpBuild, | ||
| buildFailed: true | ||
| } | ||
|
|
||
| const longArgsBuild: BuildResult = { | ||
| ...successfulHelpBuild, | ||
| requestedTasks: 'check publishMyLongNamePluginPublicationToMavenCentral publishMyLongNamePluginPublicationToPluginPortal', | ||
| } | ||
|
|
||
| const scanPublishDisabledBuild: BuildResult = { | ||
| ...successfulHelpBuild, | ||
| buildScanUri: '', | ||
| buildScanFailed: false, | ||
| } | ||
|
|
||
| const scanPublishFailedBuild: BuildResult = { | ||
| ...successfulHelpBuild, | ||
| buildScanUri: '', | ||
| buildScanFailed: true, | ||
| } | ||
|
|
||
| describe('renderSummaryTable', () => { | ||
| describe('renders', () => { | ||
| it('successful build', () => { | ||
| const table = renderSummaryTable([successfulHelpBuild]) | ||
| expect(table.trim()).toBe(dedent` | ||
| <table> | ||
| <tr> | ||
| <th>Gradle Root Project</th> | ||
| <th>Requested Tasks</th> | ||
| <th>Gradle Version</th> | ||
| <th>Build Outcome</th> | ||
| <th>Build Scan®</th> | ||
| </tr> | ||
| <tr> | ||
| <td>root</td> | ||
| <td>help</td> | ||
| <td align='center'>8.0</td> | ||
| <td align='center'>:white_check_mark:</td> | ||
| <td><a href="https://scans.gradle.com/s/abc123" rel="nofollow" target="_blank"><img src="https://img.shields.io/badge/Build%20Scan%C2%AE-06A0CE?logo=Gradle" alt="Build Scan published" /></a></td> | ||
| </tr> | ||
| </table> | ||
| `); | ||
| }) | ||
| it('failed build', () => { | ||
| const table = renderSummaryTable([failedHelpBuild]) | ||
| expect(table.trim()).toBe(dedent` | ||
| <table> | ||
| <tr> | ||
| <th>Gradle Root Project</th> | ||
| <th>Requested Tasks</th> | ||
| <th>Gradle Version</th> | ||
| <th>Build Outcome</th> | ||
| <th>Build Scan®</th> | ||
| </tr> | ||
| <tr> | ||
| <td>root</td> | ||
| <td>help</td> | ||
| <td align='center'>8.0</td> | ||
| <td align='center'>:x:</td> | ||
| <td><a href="https://scans.gradle.com/s/abc123" rel="nofollow" target="_blank"><img src="https://img.shields.io/badge/Build%20Scan%C2%AE-06A0CE?logo=Gradle" alt="Build Scan published" /></a></td> | ||
| </tr> | ||
| </table> | ||
| `); | ||
| }) | ||
| describe('when build scan', () => { | ||
| it('publishing disabled', () => { | ||
| const table = renderSummaryTable([scanPublishDisabledBuild]) | ||
| expect(table.trim()).toBe(dedent` | ||
| <table> | ||
| <tr> | ||
| <th>Gradle Root Project</th> | ||
| <th>Requested Tasks</th> | ||
| <th>Gradle Version</th> | ||
| <th>Build Outcome</th> | ||
| <th>Build Scan®</th> | ||
| </tr> | ||
| <tr> | ||
| <td>root</td> | ||
| <td>help</td> | ||
| <td align='center'>8.0</td> | ||
| <td align='center'>:white_check_mark:</td> | ||
| <td><a href="https://scans.gradle.com" rel="nofollow" target="_blank"><img src="https://img.shields.io/badge/Not%20published-lightgrey" alt="Build Scan not published" /></a></td> | ||
| </tr> | ||
| </table> | ||
| `); | ||
| }) | ||
| it('publishing failed', () => { | ||
| const table = renderSummaryTable([scanPublishFailedBuild]) | ||
| expect(table.trim()).toBe(dedent` | ||
| <table> | ||
| <tr> | ||
| <th>Gradle Root Project</th> | ||
| <th>Requested Tasks</th> | ||
| <th>Gradle Version</th> | ||
| <th>Build Outcome</th> | ||
| <th>Build Scan®</th> | ||
| </tr> | ||
| <tr> | ||
| <td>root</td> | ||
| <td>help</td> | ||
| <td align='center'>8.0</td> | ||
| <td align='center'>:white_check_mark:</td> | ||
| <td><a href="https://docs.gradle.com/develocity/gradle-plugin/#troubleshooting" rel="nofollow" target="_blank"><img src="https://img.shields.io/badge/Publish%20failed-orange" alt="Build Scan publish failed" /></a></td> | ||
| </tr> | ||
| </table> | ||
| `); | ||
| }) | ||
| }) | ||
| it('multiple builds', () => { | ||
| const table = renderSummaryTable([successfulHelpBuild, failedHelpBuild]) | ||
| expect(table.trim()).toBe(dedent` | ||
| <table> | ||
| <tr> | ||
| <th>Gradle Root Project</th> | ||
| <th>Requested Tasks</th> | ||
| <th>Gradle Version</th> | ||
| <th>Build Outcome</th> | ||
| <th>Build Scan®</th> | ||
| </tr> | ||
| <tr> | ||
| <td>root</td> | ||
| <td>help</td> | ||
| <td align='center'>8.0</td> | ||
| <td align='center'>:white_check_mark:</td> | ||
| <td><a href="https://scans.gradle.com/s/abc123" rel="nofollow" target="_blank"><img src="https://img.shields.io/badge/Build%20Scan%C2%AE-06A0CE?logo=Gradle" alt="Build Scan published" /></a></td> | ||
| </tr> | ||
| <tr> | ||
| <td>root</td> | ||
| <td>help</td> | ||
| <td align='center'>8.0</td> | ||
| <td align='center'>:x:</td> | ||
| <td><a href="https://scans.gradle.com/s/abc123" rel="nofollow" target="_blank"><img src="https://img.shields.io/badge/Build%20Scan%C2%AE-06A0CE?logo=Gradle" alt="Build Scan published" /></a></td> | ||
| </tr> | ||
| </table> | ||
| `); | ||
| }) | ||
| it('truncating long requested tasks', () => { | ||
| const table = renderSummaryTable([longArgsBuild]) | ||
| expect(table.trim()).toBe(dedent` | ||
| <table> | ||
| <tr> | ||
| <th>Gradle Root Project</th> | ||
| <th>Requested Tasks</th> | ||
| <th>Gradle Version</th> | ||
| <th>Build Outcome</th> | ||
| <th>Build Scan®</th> | ||
| </tr> | ||
| <tr> | ||
| <td>root</td> | ||
| <td><div title='check publishMyLongNamePluginPublicationToMavenCentral publishMyLongNamePluginPublicationToPluginPortal'>check publishMyLongNamePluginPublicationToMavenCentral publ…</div></td> | ||
| <td align='center'>8.0</td> | ||
| <td align='center'>:white_check_mark:</td> | ||
| <td><a href="https://scans.gradle.com/s/abc123" rel="nofollow" target="_blank"><img src="https://img.shields.io/badge/Build%20Scan%C2%AE-06A0CE?logo=Gradle" alt="Build Scan published" /></a></td> | ||
| </tr> | ||
| </table> | ||
| `); | ||
| }) | ||
| }) | ||
| }) |