From fd37df8bc4b92b50d54009fa9f1c144d7d9ce40d Mon Sep 17 00:00:00 2001 From: Daniel Kastl Date: Tue, 18 Nov 2025 07:48:15 +0900 Subject: [PATCH 1/4] Add GitHub Issue & PR Templates resource to catalog Signed-off-by: Daniel Kastl --- catalog-info.yaml | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/catalog-info.yaml b/catalog-info.yaml index 74d91d6..9d582e1 100644 --- a/catalog-info.yaml +++ b/catalog-info.yaml @@ -20,6 +20,7 @@ spec: system: geolonia/standards dependsOn: - resource:geolonia/github-workflow-templates + - resource:geolonia/github-issue-templates --- apiVersion: backstage.io/v1alpha1 @@ -40,3 +41,26 @@ spec: type: workflow-template owner: group:geolonia/operations system: geolonia/standards + +--- +apiVersion: backstage.io/v1alpha1 +kind: Resource +metadata: + namespace: geolonia + name: github-issue-templates + title: GitHub Issue & PR Templates + description: Shared issue forms and pull request template applied org-wide. + tags: + - github + - templates + links: + - url: https://github.com/geolonia/.github/tree/main/.github/ISSUE_TEMPLATE + title: Issue templates + icon: github + - url: https://github.com/geolonia/.github/blob/main/.github/pull_request_template.md + title: Pull request template + icon: github +spec: + type: template + owner: group:geolonia/operations + system: geolonia/standards From dc4479c3c32f60224b7f84b1dcc5911f226174ee Mon Sep 17 00:00:00 2001 From: Daniel Kastl Date: Tue, 18 Nov 2025 09:28:29 +0900 Subject: [PATCH 2/4] Change workflow type from 'workflow-template' to 'template' --- catalog-info.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/catalog-info.yaml b/catalog-info.yaml index 9d582e1..14b966c 100644 --- a/catalog-info.yaml +++ b/catalog-info.yaml @@ -38,7 +38,7 @@ metadata: title: Workflow templates icon: github spec: - type: workflow-template + type: template owner: group:geolonia/operations system: geolonia/standards From 825f7f26323517099585f79be6d792a02a6ffa67 Mon Sep 17 00:00:00 2001 From: Daniel Kastl Date: Tue, 18 Nov 2025 09:39:05 +0900 Subject: [PATCH 3/4] Add lifecycle property to workflow templates --- catalog-info.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/catalog-info.yaml b/catalog-info.yaml index 14b966c..1876e1f 100644 --- a/catalog-info.yaml +++ b/catalog-info.yaml @@ -39,6 +39,7 @@ metadata: icon: github spec: type: template + lifecycle: production owner: group:geolonia/operations system: geolonia/standards @@ -62,5 +63,6 @@ metadata: icon: github spec: type: template + lifecycle: production owner: group:geolonia/operations system: geolonia/standards From 3bbdc8ca4716bf735cfc381abc6b4a54370be6c8 Mon Sep 17 00:00:00 2001 From: Daniel Kastl Date: Thu, 20 Nov 2025 08:28:40 +0900 Subject: [PATCH 4/4] Update AWS_ACCOUNT_ID references to TECHDOCS_AWS_ACCOUNT_ID in workflows and documentation Signed-off-by: Daniel Kastl --- .github/workflows/publish-techdocs.yml | 2 +- .github/workflows/reusable-backstage-techdocs.yml | 6 +++--- docs/workflows.md | 4 ++-- workflow-templates/publish-techdocs.yml | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/workflows/publish-techdocs.yml b/.github/workflows/publish-techdocs.yml index c3e57ac..2e7f9c7 100644 --- a/.github/workflows/publish-techdocs.yml +++ b/.github/workflows/publish-techdocs.yml @@ -17,4 +17,4 @@ jobs: techdocs_bucket: ${{ vars.TECHDOCS_BUCKET }} techdocs_entity: ${{ vars.TECHDOCS_ENTITY }} secrets: - AWS_ACCOUNT_ID: ${{ secrets.AWS_ACCOUNT_ID }} + AWS_ACCOUNT_ID: ${{ secrets.TECHDOCS_AWS_ACCOUNT_ID }} diff --git a/.github/workflows/reusable-backstage-techdocs.yml b/.github/workflows/reusable-backstage-techdocs.yml index a13d0a6..5f0aeab 100644 --- a/.github/workflows/reusable-backstage-techdocs.yml +++ b/.github/workflows/reusable-backstage-techdocs.yml @@ -45,7 +45,7 @@ on: required: false type: string aws_role_arn: - description: "Role to assume; if empty, builds ARN from AWS_ACCOUNT_ID" + description: "Role to assume; if empty, builds ARN from TECHDOCS_AWS_ACCOUNT_ID" required: false type: string build_directory: @@ -66,7 +66,7 @@ env: MKDOCS_CORE_VER: ${{ inputs.mkdocs_core_version || vars.MKDOCS_TECHDOCS_CORE_VERSION || '>=1.6,<2.0' }} AWS_REGION: ${{ inputs.aws_region || vars.AWS_REGION || 'ap-northeast-1' }} - AWS_ACCOUNT_ID: ${{ secrets.AWS_ACCOUNT_ID }} + AWS_ACCOUNT_ID: ${{ secrets.TECHDOCS_AWS_ACCOUNT_ID }} TECHDOCS_BUCKET: ${{ inputs.techdocs_bucket || vars.TECHDOCS_BUCKET || 'geolonia-backstage-techdocs' }} TECHDOCS_ENTITY: ${{ inputs.techdocs_entity || vars.TECHDOCS_ENTITY || format('geolonia/component/{0}', github.event.repository.name) }} @@ -110,7 +110,7 @@ jobs: - name: Configure AWS credentials (OIDC) uses: aws-actions/configure-aws-credentials@v4 with: - role-to-assume: ${{ inputs.aws_role_arn != '' && inputs.aws_role_arn || format('arn:aws:iam::{0}:role/GitHubActionsTechDocsPublisher', env.AWS_ACCOUNT_ID) }} + role-to-assume: ${{ inputs.aws_role_arn != '' && inputs.aws_role_arn || format('arn:aws:iam::{0}:role/GitHubActionsTechDocsPublisher', env.TECHDOCS_AWS_ACCOUNT_ID) }} aws-region: ${{ env.AWS_REGION }} - name: Generate TechDocs (no Docker) diff --git a/docs/workflows.md b/docs/workflows.md index 45d1770..52ed376 100644 --- a/docs/workflows.md +++ b/docs/workflows.md @@ -25,8 +25,8 @@ on their own schedule. - Runs on `main` when `docs/**` or `mkdocs.yml` changes, or manually via `workflow_dispatch`. - Delegates to `reusable-backstage-techdocs.yml@v1` with safe defaults for AWS region, environment, and tool versions. -- Requires `AWS_ACCOUNT_ID` in repo secrets; S3 bucket/role overrides can be - passed through vars or workflow inputs if needed. +- Requires `TECHDOCS_AWS_ACCOUNT_ID` in repo secrets; S3 bucket/role overrides + can be passed through vars or workflow inputs if needed. Example minimal usage after selecting the template: diff --git a/workflow-templates/publish-techdocs.yml b/workflow-templates/publish-techdocs.yml index 6639e1b..2e2dd2c 100644 --- a/workflow-templates/publish-techdocs.yml +++ b/workflow-templates/publish-techdocs.yml @@ -34,4 +34,4 @@ jobs: # aws_role_arn: arn:aws:iam::123456789012:role/CustomTechDocsRole secrets: - AWS_ACCOUNT_ID: ${{ secrets.AWS_ACCOUNT_ID }} + AWS_ACCOUNT_ID: ${{ secrets.TECHDOCS_AWS_ACCOUNT_ID }}