From 7b5ece3d737566aec43063869c49a2e3ac4ebcce Mon Sep 17 00:00:00 2001 From: "enghub-ops-integration[bot]" <141459326+enghub-ops-integration[bot]@users.noreply.github.com> Date: Fri, 16 May 2025 10:31:42 +0000 Subject: [PATCH 1/4] Register Component into Software Catalog and set up TechDocs publishing --- .github/workflows/publish-techdocs.yaml | 25 +++++++++++++++++++++++++ catalog-info.yaml | 14 ++++++++++++++ mkdocs.yml | 14 ++++++++++++++ 3 files changed, 53 insertions(+) create mode 100644 .github/workflows/publish-techdocs.yaml create mode 100644 catalog-info.yaml create mode 100644 mkdocs.yml diff --git a/.github/workflows/publish-techdocs.yaml b/.github/workflows/publish-techdocs.yaml new file mode 100644 index 0000000..9dd709e --- /dev/null +++ b/.github/workflows/publish-techdocs.yaml @@ -0,0 +1,25 @@ +name: Publish TechDocs +on: + push: + branches: + - main + paths: + - 'docs/**' + - 'mkdocs.yml' + - 'catalog-info.yaml' + - '.github/workflows/publish-techdocs.yaml' +concurrency: + group: '${{ github.workflow }}-${{ github.ref }}' + cancel-in-progress: true +permissions: {} +jobs: + publish-docs: + uses: grafana/shared-workflows/.github/workflows/publish-techdocs.yaml@main + permissions: + contents: read + id-token: write + with: + namespace: default + kind: component + name: xk6-sql-driver-postgres + default-working-directory: . diff --git a/catalog-info.yaml b/catalog-info.yaml new file mode 100644 index 0000000..ee653b9 --- /dev/null +++ b/catalog-info.yaml @@ -0,0 +1,14 @@ +apiVersion: backstage.io/v1alpha1 +kind: Component +metadata: + name: xk6-sql-driver-postgres + title: xk6-sql-driver-postgres + description: | + xk6-sql driver extension for Postgres database support + annotations: + backstage.io/techdocs-ref: dir:. + github.com/project-slug: grafana/xk6-sql-driver-postgres +spec: + type: library + owner: group:default/k6-extensions + lifecycle: production diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..e62dbfb --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,14 @@ +# To run locally +# npx @techdocs/cli serve -v -c ./mkdocs.yml +# +site_name: 'xk6-sql-driver-postgres Internal Documentation' +repo_url: https://github.com/grafana/xk6-sql-driver-postgres +edit_uri: edit/main/docs + +theme: + name: material + features: + - navigation.sections + +plugins: + - techdocs-core From 0809b3f150e4ec2eeb7a125dde0e40051688c778 Mon Sep 17 00:00:00 2001 From: Erik Sommer Date: Fri, 16 May 2025 12:31:59 +0200 Subject: [PATCH 2/4] Delete .github/workflows/publish-techdocs.yaml --- .github/workflows/publish-techdocs.yaml | 25 ------------------------- 1 file changed, 25 deletions(-) delete mode 100644 .github/workflows/publish-techdocs.yaml diff --git a/.github/workflows/publish-techdocs.yaml b/.github/workflows/publish-techdocs.yaml deleted file mode 100644 index 9dd709e..0000000 --- a/.github/workflows/publish-techdocs.yaml +++ /dev/null @@ -1,25 +0,0 @@ -name: Publish TechDocs -on: - push: - branches: - - main - paths: - - 'docs/**' - - 'mkdocs.yml' - - 'catalog-info.yaml' - - '.github/workflows/publish-techdocs.yaml' -concurrency: - group: '${{ github.workflow }}-${{ github.ref }}' - cancel-in-progress: true -permissions: {} -jobs: - publish-docs: - uses: grafana/shared-workflows/.github/workflows/publish-techdocs.yaml@main - permissions: - contents: read - id-token: write - with: - namespace: default - kind: component - name: xk6-sql-driver-postgres - default-working-directory: . From ebc4a6d22ef6f57cec33c0058c812a827c3ed44d Mon Sep 17 00:00:00 2001 From: Erik Sommer Date: Fri, 16 May 2025 12:32:07 +0200 Subject: [PATCH 3/4] Delete mkdocs.yml --- mkdocs.yml | 14 -------------- 1 file changed, 14 deletions(-) delete mode 100644 mkdocs.yml diff --git a/mkdocs.yml b/mkdocs.yml deleted file mode 100644 index e62dbfb..0000000 --- a/mkdocs.yml +++ /dev/null @@ -1,14 +0,0 @@ -# To run locally -# npx @techdocs/cli serve -v -c ./mkdocs.yml -# -site_name: 'xk6-sql-driver-postgres Internal Documentation' -repo_url: https://github.com/grafana/xk6-sql-driver-postgres -edit_uri: edit/main/docs - -theme: - name: material - features: - - navigation.sections - -plugins: - - techdocs-core From d7efa0d7744fe88628b19b64b4bfa42c65a11748 Mon Sep 17 00:00:00 2001 From: Erik Sommer Date: Fri, 16 May 2025 12:32:20 +0200 Subject: [PATCH 4/4] Update catalog-info.yaml --- catalog-info.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/catalog-info.yaml b/catalog-info.yaml index ee653b9..b9c4545 100644 --- a/catalog-info.yaml +++ b/catalog-info.yaml @@ -6,7 +6,6 @@ metadata: description: | xk6-sql driver extension for Postgres database support annotations: - backstage.io/techdocs-ref: dir:. github.com/project-slug: grafana/xk6-sql-driver-postgres spec: type: library