Skip to content

Commit 7b5ece3

Browse files
Register Component into Software Catalog and set up TechDocs publishing
1 parent bf0d938 commit 7b5ece3

File tree

3 files changed

+53
-0
lines changed

3 files changed

+53
-0
lines changed
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Publish TechDocs
2+
on:
3+
push:
4+
branches:
5+
- main
6+
paths:
7+
- 'docs/**'
8+
- 'mkdocs.yml'
9+
- 'catalog-info.yaml'
10+
- '.github/workflows/publish-techdocs.yaml'
11+
concurrency:
12+
group: '${{ github.workflow }}-${{ github.ref }}'
13+
cancel-in-progress: true
14+
permissions: {}
15+
jobs:
16+
publish-docs:
17+
uses: grafana/shared-workflows/.github/workflows/publish-techdocs.yaml@main
18+
permissions:
19+
contents: read
20+
id-token: write
21+
with:
22+
namespace: default
23+
kind: component
24+
name: xk6-sql-driver-postgres
25+
default-working-directory: .

catalog-info.yaml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
apiVersion: backstage.io/v1alpha1
2+
kind: Component
3+
metadata:
4+
name: xk6-sql-driver-postgres
5+
title: xk6-sql-driver-postgres
6+
description: |
7+
xk6-sql driver extension for Postgres database support
8+
annotations:
9+
backstage.io/techdocs-ref: dir:.
10+
github.com/project-slug: grafana/xk6-sql-driver-postgres
11+
spec:
12+
type: library
13+
owner: group:default/k6-extensions
14+
lifecycle: production

mkdocs.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# To run locally
2+
# npx @techdocs/cli serve -v -c ./mkdocs.yml
3+
#
4+
site_name: 'xk6-sql-driver-postgres Internal Documentation'
5+
repo_url: https://github.com/grafana/xk6-sql-driver-postgres
6+
edit_uri: edit/main/docs
7+
8+
theme:
9+
name: material
10+
features:
11+
- navigation.sections
12+
13+
plugins:
14+
- techdocs-core

0 commit comments

Comments
 (0)