From 0f30b99bc29102c010fdaae1b8d5427d35697369 Mon Sep 17 00:00:00 2001 From: Andreas Stenius Date: Tue, 23 Feb 2021 13:43:55 +0100 Subject: [PATCH] badges: cleanup. enforce all template fields to be lower case. thanx @adamdmharvey Signed-off-by: Andreas Stenius --- app-config.yaml | 10 ---------- plugins/badges-backend/src/badges.ts | 8 +++----- .../src/lib/BadgeBuilder/DefaultBadgeBuilder.ts | 7 +++++-- 3 files changed, 8 insertions(+), 17 deletions(-) diff --git a/app-config.yaml b/app-config.yaml index 21b3c3199d..465c7b0049 100644 --- a/app-config.yaml +++ b/app-config.yaml @@ -401,13 +401,3 @@ homepage: timezone: 'Asia/Tokyo' pagerduty: eventsBaseUrl: 'https://events.pagerduty.com/v2' - -# sample badges -badges: - lifecycle: - kind: 'entity' - description: 'Entity lifecycle badge' - link: '_{entity_url}' - label: 'lifecycle' - message: '_{entity.spec.lifecycle}' - style: for-the-badge diff --git a/plugins/badges-backend/src/badges.ts b/plugins/badges-backend/src/badges.ts index 253b6c0166..c830fbcfa2 100644 --- a/plugins/badges-backend/src/badges.ts +++ b/plugins/badges-backend/src/badges.ts @@ -20,9 +20,9 @@ export const badges: Badge[] = [ { id: 'pingback', kind: 'entity', - description: 'Link back to _{app.title}', - label: '_{app.title}', - message: '_{entity.kind}: _{entity.metadata.name}', + description: 'Link to _{entity.metadata.name} in _{app.title}', + label: '_{entity.kind}', + message: '_{entity.metadata.name}', style: 'flat-square', }, { @@ -39,7 +39,6 @@ export const badges: Badge[] = [ description: 'Entity owner badge', label: 'owner', message: '_{entity.spec.owner}', - color: 'blue', style: 'flat-square', }, { @@ -48,7 +47,6 @@ export const badges: Badge[] = [ link: '_{entity_url}/docs', label: 'docs', message: '_{entity.metadata.name}', - color: 'navyblue', style: 'flat-square', }, ]; diff --git a/plugins/badges-backend/src/lib/BadgeBuilder/DefaultBadgeBuilder.ts b/plugins/badges-backend/src/lib/BadgeBuilder/DefaultBadgeBuilder.ts index c1ff60056c..76d2645b51 100644 --- a/plugins/badges-backend/src/lib/BadgeBuilder/DefaultBadgeBuilder.ts +++ b/plugins/badges-backend/src/lib/BadgeBuilder/DefaultBadgeBuilder.ts @@ -100,7 +100,7 @@ export class DefaultBadgeBuilder implements BadgeBuilder { private render(template: string, context: object): string { try { - return interpolate(template.replace(/_{/g, '${'), context); + return interpolate(template.replace(/_{/g, '${'), context).toLowerCase(); } catch (err) { this.logger.info( `badge template error: ${err}. In template: "${template}"`, @@ -110,7 +110,10 @@ export class DefaultBadgeBuilder implements BadgeBuilder { } private getMarkdownCode(params: Badge, badge_url: string): string { - const alt_text = `${params.description}, ${params.label}: ${params.message}`; + let alt_text = `${params.label}: ${params.message}`; + if (params.description !== params.label) { + alt_text = `${params.description}, ${alt_text}`; + } const tooltip = params.description ? ` "${params.description}"` : ''; const img = `![${alt_text}](${badge_url}${tooltip})`; return params.link ? `[${img}](${params.link})` : img;