Skip to content

Commit 2603706

Browse files
authored
Merge pull request #1146 from hmcts/add-catalog-info-yaml
Add a commented out catalog-info.yaml file for Backstage
2 parents 406a681 + a1ae1b0 commit 2603706

File tree

2 files changed

+43
-0
lines changed

2 files changed

+43
-0
lines changed

.prettierignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@ src/main/public/main*.js
55
.pnp.*
66
src/main/views/govuk
77
.yarn/
8+
catalog-info.yaml

catalog-info.yaml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# The below YAML is a template for a Backstage catalog-info.yaml file. It should be updated to match the details of your service/component where applicable.
2+
# For further information on how to update this file to use other features of HMCTS Backstage, please see the HMCTS Backstage examples README: https://github.com/hmcts/backstage-hmcts-examples
3+
apiVersion: backstage.io/v1alpha1
4+
kind: Component
5+
metadata:
6+
name: "${{ values.product }}-${{ values.component }}"
7+
description: "${{ values.description }}"
8+
annotations:
9+
# This should match folder-name/job-name in Jenkins.
10+
jenkins.io/job-full-name: cft:HMCTS_${{ values.product }}/${{ values.destination.repo }}
11+
github.com/project-slug: '${{ values.destination.owner }}/${{ values.destination.repo }}'
12+
tags:
13+
- nodejs
14+
links:
15+
- url: https://hmcts-reform.slack.com/app_redirect?channel=${{ values.slack_contact_channel }}
16+
title: ${{ values.slack_contact_channel }} on Slack
17+
icon: chat
18+
spec:
19+
type: service
20+
system: ${{ values.product }}
21+
lifecycle: experimental
22+
owner: ${{ values.owner }}
23+
24+
# Uncomment the below once the project has an API file to link to
25+
#---
26+
#
27+
#apiVersion: backstage.io/v1alpha1
28+
#kind: API
29+
#metadata:
30+
# name: "${{ values.description }}-api"
31+
# description: Update this description to describe the purpose of this API entity
32+
# annotations:
33+
# github.com/project-slug: '${{ values.destination.owner }}/${{ values.destination.repo }}'
34+
#spec:
35+
# type: openapi
36+
# lifecycle: experimental
37+
# owner: ${{ values.owner }}
38+
# system: ${{ values.product }}
39+
# apiProvidedBy: "${{ values.product }}-${{ values.component }}"
40+
# definition:
41+
# # Update the below to the raw URL of your OpenAPI spec
42+
# $text: https://raw.githubusercontent.com/hmcts/backstage-hmcts-examples/master/src/main/resources/openapi/testspec.yaml

0 commit comments

Comments
 (0)