Prompt file imported from ozeta/poc-idp-lab (.github/prompts/setup-backstage-instance.prompt.md). Fill in {{GITHUB_TOKEN}} before use. Copyright stays with the author.

Set up Backstage with GitHub token and repo template

Name: setup-backstage-instance
Author: ozeta

You are helping the user create a fresh Backstage instance, configure it with a GitHub Personal Access Token, and add the "New Repository with README" scaffolder template.

Prerequisites

Node.js >= 20 and Yarn installed
A GitHub Personal Access Token (classic) with scopes: repo, workflow, delete_repo

Steps

1. Scaffold the Backstage app

Run the Backstage create-app CLI in the target directory:

npx @backstage/create-app@latest

Follow the prompts to name the app (default: the current folder name).

2. Configure the GitHub token

Create a .env file in the Backstage app root:

export GITHUB_TOKEN=<ask the user for their token>

Make sure .env is listed in .gitignore (Backstage includes it by default).

3. Verify GitHub integration config

Confirm app-config.yaml contains the integration block with the token variable:

integrations:
  github:
    - host: github.com
      token: {{GITHUB_TOKEN}}

This is included by default in a new Backstage app. If missing, add it.

4. Create the repo template

Create the directory examples/repo-template/content/ and add the following files.

4.1 Template definition — `examples/repo-template/template.yaml`

apiVersion: scaffolder.backstage.io/v1beta3
kind: Template
metadata:
  name: new-repo-with-readme
  title: New Repository with README
  description: Creates a new GitHub repository pre-populated with a README and a Backstage catalog descriptor.
spec:
  owner: user:guest
  type: service

  parameters:
    - title: Component details
      required:
        - name
        - description
      properties:
        name:
          title: Name
          type: string
          description: Unique name of the component (used as the repo and catalog entry name)
          ui:autofocus: true
        description:
          title: Description
          type: string
          description: A short description of this repository
        owner:
          title: Owner
          type: string
          description: Owner of the component
          ui:field: OwnerPicker
          ui:options:
            catalogFilter:
              kind: [Group, User]
        codeowners:
          title: Code Owners
          type: string
          description: 'GitHub CODEOWNERS entry (e.g. @org/team-name or @username)'
    - title: Choose a location
      required:
        - repoUrl
      properties:
        repoUrl:
          title: Repository Location
          type: string
          ui:field: RepoUrlPicker
          ui:options:
            allowedHosts:
              - github.com

  steps:
    - id: fetch-base
      name: Fetch Base
      action: fetch:template
      input:
        url: ./content
        values:
          name: ${{ parameters.name }}
          description: ${{ parameters.description }}
          owner: ${{ parameters.owner }}
          codeowners: ${{ parameters.codeowners }}

    - id: publish
      name: Publish to GitHub
      action: publish:github
      input:
        description: ${{ parameters.description }}
        repoUrl: ${{ parameters.repoUrl }}
        defaultBranch: main

    - id: register
      name: Register in Catalog
      action: catalog:register
      input:
        repoContentsUrl: ${{ steps['publish'].output.repoContentsUrl }}
        catalogInfoPath: /catalog-info.yaml

    - id: notify
      name: Notify
      action: notification:send
      input:
        recipients: entity
        entityRefs:
          - user:default/guest
        title: Repository created
        info: '${{ parameters.name }} has been created and registered in the catalog.'
        severity: normal

  output:
    links:
      - title: Repository
        url: ${{ steps['publish'].output.remoteUrl }}
      - title: Open in catalog
        icon: catalog
        entityRef: ${{ steps['register'].output.entityRef }}

4.2 Content files under `examples/repo-template/content/`

Create each of these files exactly as shown:

README.md

# ${{ values.name }}

${{ values.description }}

## Getting Started

1. Clone this repository:

   ```sh
   git clone <repository-url>
   cd ${{ values.name }}

Install dependencies and follow the project-specific setup instructions.
You're ready to go!


**`catalog-info.yaml`**
```yaml
apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
  name: ${{ values.name | dump }}
  description: ${{ values.description | dump }}
spec:
  type: service
  owner: ${{ values.owner | dump }}
  lifecycle: experimental

CODEOWNERS

# Default code owners for the entire repository
* ${{ values.codeowners }}

.devcontainer/devcontainer.json

{
  "name": "Python Dev Container",
  "image": "mcr.microsoft.com/devcontainers/python:3.11",
  "features": {
    "ghcr.io/devcontainers/features/git:1": {},
    "ghcr.io/devcontainers-contrib/features/pre-commit:2": {}
  },
  "postCreateCommand": "pip install -r requirements.txt && pre-commit install",
  "customizations": {
    "vscode": {
      "extensions": [
        "ms-python.python",
        "ms-python.vscode-pylance",
        "charliermarsh.ruff",
        "eamodio.gitlens"
      ],
      "settings": {
        "python.defaultInterpreterPath": "/usr/local/bin/python"
      }
    }
  }
}

.pre-commit-config.yaml

repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.6.0
    hooks:
      - id: trailing-whitespace
      - id: end-of-file-fixer
      - id: check-yaml
      - id: check-added-large-files
      - id: check-merge-conflict

  - repo: https://github.com/astral-sh/ruff-pre-commit
    rev: v0.4.4
    hooks:
      - id: ruff
        args: [--fix]
      - id: ruff-format

  - repo: https://github.com/pre-commit/mirrors-mypy
    rev: v1.10.0
    hooks:
      - id: mypy
        additional_dependencies: []

.github/PULL_REQUEST_TEMPLATE.md

## Description

<!-- Describe your changes in detail -->

## Type of Change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Documentation update

## Checklist

- [ ] My code follows the project's style guidelines
- [ ] I have performed a self-review of my code
- [ ] I have added tests that prove my fix is effective or my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] I have updated the documentation accordingly

## Related Issues

<!-- Link related issues: Fixes #123, Closes #456 -->

.updatecli/updatecli.d/python.yaml

name: Update Python dependencies

scms:
  default:
    kind: github
    spec:
      user: "{{ .github.user }}"
      email: "{{ .github.email }}"
      owner: "{{ .github.owner }}"
      repository: "{{ .github.repository }}"
      branch: main

sources:
  pip:
    name: Check for pip package updates
    kind: shell
    spec:
      command: pip index versions pip --pre 2>/dev/null | head -1 | grep -oP '\([\d.]+\)'

targets:
  requirements:
    name: Update requirements.txt
    kind: file
    sourceid: pip
    spec:
      file: requirements.txt
    scmid: default

actions:
  default:
    kind: github/pullrequest
    scmid: default
    spec:
      title: "chore(deps): update Python dependencies"
      labels:
        - dependencies
        - automated

5. Register the template in catalog config

Add the following entry to catalog.locations in both app-config.yaml and app-config.production.yaml:

For app-config.yaml (paths relative to packages/backend):

    - type: file
      target: ../../examples/repo-template/template.yaml
      rules:
        - allow: [Template]

For app-config.production.yaml (paths relative to app root):

    - type: file
      target: ./examples/repo-template/template.yaml
      rules:
        - allow: [Template]

6. Start the app

source .env && yarn dev

7. Verify

Open the Backstage UI at http://localhost:3000
Navigate to the Scaffolder page ("Create..." in the sidebar)
Confirm the New Repository with README template is listed
Optionally run it with a test repo to verify all files are generated correctly

# Set up Backstage with GitHub token and repo template You are helping the user create a fresh Backstage instance, configure it with a GitHub Personal Access Token, and add the "New Repository with README" scaffolder template. ## Prerequisites - Node.js >= 20 and Yarn installed - A GitHub Personal Access Token (classic) with scopes: `repo`, `workflow`, `delete_repo` ## Steps ### 1. Scaffold the Backstage app Run the Backstage create-app CLI in the target directory: ``` npx @backstage/create-app@latest ``` Follow the prompts to name the app (default: the current folder name). ### 2. Configure the GitHub token Create a `.env` file in the Backstage app root: ``` export GITHUB_TOKEN=<ask the user for their token> ``` Make sure `.env` is listed in `.gitignore` (Backstage includes it by default). ### 3. Verify GitHub integration config Confirm `app-config.yaml` contains the integration block with the token variable: ```yaml integrations: github: - host: github.com token: {{GITHUB_TOKEN}} ``` This is included by default in a new Backstage app. If missing, add it. ### 4. Create the repo template Create the directory `examples/repo-template/content/` and add the following files. #### 4.1 Template definition — `examples/repo-template/template.yaml` ```yaml apiVersion: scaffolder.backstage.io/v1beta3 kind: Template metadata: name: new-repo-with-readme title: New Repository with README description: Creates a new GitHub repository pre-populated with a README and a Backstage catalog descriptor. spec: owner: user:guest type: service parameters: - title: Component details required: - name - description properties: name: title: Name type: string description: Unique name of the component (used as the repo and catalog entry name) ui:autofocus: true description: title: Description type: string description: A short description of this repository owner: title: Owner type: string description: Owner of the component ui:field: OwnerPicker ui:options: catalogFilter: kind: [Group, User] codeowners: title: Code Owners type: string description: 'GitHub CODEOWNERS entry (e.g. @org/team-name or @username)' - title: Choose a location required: - repoUrl properties: repoUrl: title: Repository Location type: string ui:field: RepoUrlPicker ui:options: allowedHosts: - github.com steps: - id: fetch-base name: Fetch Base action: fetch:template input: url: ./content values: name: ${{ parameters.name }} description: ${{ parameters.description }} owner: ${{ parameters.owner }} codeowners: ${{ parameters.codeowners }} - id: publish name: Publish to GitHub action: publish:github input: description: ${{ parameters.description }} repoUrl: ${{ parameters.repoUrl }} defaultBranch: main - id: register name: Register in Catalog action: catalog:register input: repoContentsUrl: ${{ steps['publish'].output.repoContentsUrl }} catalogInfoPath: /catalog-info.yaml - id: notify name: Notify action: notification:send input: recipients: entity entityRefs: - user:default/guest title: Repository created info: '${{ parameters.name }} has been created and registered in the catalog.' severity: normal output: links: - title: Repository url: ${{ steps['publish'].output.remoteUrl }} - title: Open in catalog icon: catalog entityRef: ${{ steps['register'].output.entityRef }} ``` #### 4.2 Content files under `examples/repo-template/content/` Create each of these files exactly as shown: **`README.md`** ```markdown # ${{ values.name }} ${{ values.description }} ## Getting Started 1. Clone this repository: ```sh git clone <repository-url> cd ${{ values.name }} ``` 2. Install dependencies and follow the project-specific setup instructions. 3. You're ready to go! ``` **`catalog-info.yaml`** ```yaml apiVersion: backstage.io/v1alpha1 kind: Component metadata: name: ${{ values.name | dump }} description: ${{ values.description | dump }} spec: type: service owner: ${{ values.owner | dump }} lifecycle: experimental ``` **`CODEOWNERS`** ``` # Default code owners for the entire repository * ${{ values.codeowners }} ``` **`.devcontainer/devcontainer.json`** ```json { "name": "Python Dev Container", "image": "mcr.microsoft.com/devcontainers/python:3.11", "features": { "ghcr.io/devcontainers/features/git:1": {}, "ghcr.io/devcontainers-contrib/features/pre-commit:2": {} }, "postCreateCommand": "pip install -r requirements.txt && pre-commit install", "customizations": { "vscode": { "extensions": [ "ms-python.python", "ms-python.vscode-pylance", "charliermarsh.ruff", "eamodio.gitlens" ], "settings": { "python.defaultInterpreterPath": "/usr/local/bin/python" } } } } ``` **`.pre-commit-config.yaml`** ```yaml repos: - repo: https://github.com/pre-commit/pre-commit-hooks rev: v4.6.0 hooks: - id: trailing-whitespace - id: end-of-file-fixer - id: check-yaml - id: check-added-large-files - id: check-merge-conflict - repo: https://github.com/astral-sh/ruff-pre-commit rev: v0.4.4 hooks: - id: ruff args: [--fix] - id: ruff-format - repo: https://github.com/pre-commit/mirrors-mypy rev: v1.10.0 hooks: - id: mypy additional_dependencies: [] ``` **`.github/PULL_REQUEST_TEMPLATE.md`** ```markdown ## Description  ## Type of Change - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] Documentation update ## Checklist - [ ] My code follows the project's style guidelines - [ ] I have performed a self-review of my code - [ ] I have added tests that prove my fix is effective or my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] I have updated the documentation accordingly ## Related Issues  ``` **`.updatecli/updatecli.d/python.yaml`** ```yaml name: Update Python dependencies scms: default: kind: github spec: user: "{{ .github.user }}" email: "{{ .github.email }}" owner: "{{ .github.owner }}" repository: "{{ .github.repository }}" branch: main sources: pip: name: Check for pip package updates kind: shell spec: command: pip index versions pip --pre 2>/dev/null | head -1 | grep -oP '$[\d.]+$' targets: requirements: name: Update requirements.txt kind: file sourceid: pip spec: file: requirements.txt scmid: default actions: default: kind: github/pullrequest scmid: default spec: title: "chore(deps): update Python dependencies" labels: - dependencies - automated ``` ### 5. Register the template in catalog config Add the following entry to `catalog.locations` in **both** `app-config.yaml` and `app-config.production.yaml`: For `app-config.yaml` (paths relative to `packages/backend`): ```yaml - type: file target: ../../examples/repo-template/template.yaml rules: - allow: [Template] ``` For `app-config.production.yaml` (paths relative to app root): ```yaml - type: file target: ./examples/repo-template/template.yaml rules: - allow: [Template] ``` ### 6. Start the app ``` source .env && yarn dev ``` ### 7. Verify - Open the Backstage UI at http://localhost:3000 - Navigate to the Scaffolder page ("Create..." in the sidebar) - Confirm the **New Repository with README** template is listed - Optionally run it with a test repo to verify all files are generated correctly

{ "prompt": "# Set up Backstage with GitHub token and repo template\n\nYou are helping the user create a fresh Backstage instance, configure it with a GitHub Personal Access Token, and add the \"New Repository with README\" scaffolder template.\n\n## Prerequisites\n\n- Node.js >= 20 and Yarn installed\n- A GitHub Personal Access Token (classic) with scopes: `repo`, `workflow`, `delete_repo`\n\n## Steps\n\n### 1. Scaffold the Backstage app\n\nRun the Backstage create-app CLI in the target directory:\n\n```\nnpx @backstage/create-app@latest\n```\n\nFollow the prompts to name the app (default: the current folder name).\n\n### 2. Configure the GitHub token\n\nCreate a `.env` file in the Backstage app root:\n\n```\nexport GITHUB_TOKEN=<ask the user for their token>\n```\n\nMake sure `.env` is listed in `.gitignore` (Backstage includes it by default).\n\n### 3. Verify GitHub integration config\n\nConfirm `app-config.yaml` contains the integration block with the token variable:\n\n```yaml\nintegrations:\n github:\n - host: github.com\n token: {{GITHUB_TOKEN}}\n```\n\nThis is included by default in a new Backstage app. If missing, add it.\n\n### 4. Create the repo template\n\nCreate the directory `examples/repo-template/content/` and add the following files.\n\n#### 4.1 Template definition — `examples/repo-template/template.yaml`\n\n```yaml\napiVersion: scaffolder.backstage.io/v1beta3\nkind: Template\nmetadata:\n name: new-repo-with-readme\n title: New Repository with README\n description: Creates a new GitHub repository pre-populated with a README and a Backstage catalog descriptor.\nspec:\n owner: user:guest\n type: service\n\n parameters:\n - title: Component details\n required:\n - name\n - description\n properties:\n name:\n title: Name\n type: string\n description: Unique name of the component (used as the repo and catalog entry name)\n ui:autofocus: true\n description:\n title: Description\n type: string\n description: A short description of this repository\n owner:\n title: Owner\n type: string\n description: Owner of the component\n ui:field: OwnerPicker\n ui:options:\n catalogFilter:\n kind: [Group, User]\n codeowners:\n title: Code Owners\n type: string\n description: 'GitHub CODEOWNERS entry (e.g. @org/team-name or @username)'\n - title: Choose a location\n required:\n - repoUrl\n properties:\n repoUrl:\n title: Repository Location\n type: string\n ui:field: RepoUrlPicker\n ui:options:\n allowedHosts:\n - github.com\n\n steps:\n - id: fetch-base\n name: Fetch Base\n action: fetch:template\n input:\n url: ./content\n values:\n name: ${{ parameters.name }}\n description: ${{ parameters.description }}\n owner: ${{ parameters.owner }}\n codeowners: ${{ parameters.codeowners }}\n\n - id: publish\n name: Publish to GitHub\n action: publish:github\n input:\n description: ${{ parameters.description }}\n repoUrl: ${{ parameters.repoUrl }}\n defaultBranch: main\n\n - id: register\n name: Register in Catalog\n action: catalog:register\n input:\n repoContentsUrl: ${{ steps['publish'].output.repoContentsUrl }}\n catalogInfoPath: /catalog-info.yaml\n\n - id: notify\n name: Notify\n action: notification:send\n input:\n recipients: entity\n entityRefs:\n - user:default/guest\n title: Repository created\n info: '${{ parameters.name }} has been created and registered in the catalog.'\n severity: normal\n\n output:\n links:\n - title: Repository\n url: ${{ steps['publish'].output.remoteUrl }}\n - title: Open in catalog\n icon: catalog\n entityRef: ${{ steps['register'].output.entityRef }}\n```\n\n#### 4.2 Content files under `examples/repo-template/content/`\n\nCreate each of these files exactly as shown:\n\n**`README.md`**\n```markdown\n# ${{ values.name }}\n\n${{ values.description }}\n\n## Getting Started\n\n1. Clone this repository:\n\n ```sh\n git clone <repository-url>\n cd ${{ values.name }}\n ```\n\n2. Install dependencies and follow the project-specific setup instructions.\n\n3. You're ready to go!\n```\n\n**`catalog-info.yaml`**\n```yaml\napiVersion: backstage.io/v1alpha1\nkind: Component\nmetadata:\n name: ${{ values.name | dump }}\n description: ${{ values.description | dump }}\nspec:\n type: service\n owner: ${{ values.owner | dump }}\n lifecycle: experimental\n```\n\n**`CODEOWNERS`**\n```\n# Default code owners for the entire repository\n* ${{ values.codeowners }}\n```\n\n**`.devcontainer/devcontainer.json`**\n```json\n{\n \"name\": \"Python Dev Container\",\n \"image\": \"mcr.microsoft.com/devcontainers/python:3.11\",\n \"features\": {\n \"ghcr.io/devcontainers/features/git:1\": {},\n \"ghcr.io/devcontainers-contrib/features/pre-commit:2\": {}\n },\n \"postCreateCommand\": \"pip install -r requirements.txt && pre-commit install\",\n \"customizations\": {\n \"vscode\": {\n \"extensions\": [\n \"ms-python.python\",\n \"ms-python.vscode-pylance\",\n \"charliermarsh.ruff\",\n \"eamodio.gitlens\"\n ],\n \"settings\": {\n \"python.defaultInterpreterPath\": \"/usr/local/bin/python\"\n }\n }\n }\n}\n```\n\n**`.pre-commit-config.yaml`**\n```yaml\nrepos:\n - repo: https://github.com/pre-commit/pre-commit-hooks\n rev: v4.6.0\n hooks:\n - id: trailing-whitespace\n - id: end-of-file-fixer\n - id: check-yaml\n - id: check-added-large-files\n - id: check-merge-conflict\n\n - repo: https://github.com/astral-sh/ruff-pre-commit\n rev: v0.4.4\n hooks:\n - id: ruff\n args: [--fix]\n - id: ruff-format\n\n - repo: https://github.com/pre-commit/mirrors-mypy\n rev: v1.10.0\n hooks:\n - id: mypy\n additional_dependencies: []\n```\n\n**`.github/PULL_REQUEST_TEMPLATE.md`**\n```markdown\n## Description\n\n\n\n## Type of Change\n\n- [ ] Bug fix (non-breaking change which fixes an issue)\n- [ ] New feature (non-breaking change which adds functionality)\n- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)\n- [ ] Documentation update\n\n## Checklist\n\n- [ ] My code follows the project's style guidelines\n- [ ] I have performed a self-review of my code\n- [ ] I have added tests that prove my fix is effective or my feature works\n- [ ] New and existing unit tests pass locally with my changes\n- [ ] I have updated the documentation accordingly\n\n## Related Issues\n\n\n```\n\n**`.updatecli/updatecli.d/python.yaml`**\n```yaml\nname: Update Python dependencies\n\nscms:\n default:\n kind: github\n spec:\n user: \"{{ .github.user }}\"\n email: \"{{ .github.email }}\"\n owner: \"{{ .github.owner }}\"\n repository: \"{{ .github.repository }}\"\n branch: main\n\nsources:\n pip:\n name: Check for pip package updates\n kind: shell\n spec:\n command: pip index versions pip --pre 2>/dev/null | head -1 | grep -oP '\$[\\d.]+\$'\n\ntargets:\n requirements:\n name: Update requirements.txt\n kind: file\n sourceid: pip\n spec:\n file: requirements.txt\n scmid: default\n\nactions:\n default:\n kind: github/pullrequest\n scmid: default\n spec:\n title: \"chore(deps): update Python dependencies\"\n labels:\n - dependencies\n - automated\n```\n\n### 5. Register the template in catalog config\n\nAdd the following entry to `catalog.locations` in **both** `app-config.yaml` and `app-config.production.yaml`:\n\nFor `app-config.yaml` (paths relative to `packages/backend`):\n```yaml\n - type: file\n target: ../../examples/repo-template/template.yaml\n rules:\n - allow: [Template]\n```\n\nFor `app-config.production.yaml` (paths relative to app root):\n```yaml\n - type: file\n target: ./examples/repo-template/template.yaml\n rules:\n - allow: [Template]\n```\n\n### 6. Start the app\n\n```\nsource .env && yarn dev\n```\n\n### 7. Verify\n\n- Open the Backstage UI at http://localhost:3000\n- Navigate to the Scaffolder page (\"Create...\" in the sidebar)\n- Confirm the **New Repository with README** template is listed\n- Optionally run it with a test repo to verify all files are generated correctly", "variables": [ "GITHUB_TOKEN" ], "notes": "Scaffold a Backstage instance with GitHub integration and the repo-template Mode: agent. Tools: create_file, replace_string_in_file, read_file, run_in_terminal, get_terminal_output.", "metadata": { "source": { "provider": "github-prompts", "repository": "https://github.com/ozeta/poc-idp-lab", "path": ".github/prompts/setup-backstage-instance.prompt.md", "ref": "3453e0d3218466231e907a93a186f618764b7c9c", "url": "https://github.com/ozeta/poc-idp-lab/blob/3453e0d3218466231e907a93a186f618764b7c9c/.github/prompts/setup-backstage-instance.prompt.md", "key": "ozeta/poc-idp-lab/.github/prompts/setup-backstage-instance.prompt.md" } } }

setup-backstage-instance

About

Set up Backstage with GitHub token and repo template

Prerequisites

Steps

1. Scaffold the Backstage app

2. Configure the GitHub token

3. Verify GitHub integration config

4. Create the repo template

4.1 Template definition — `examples/repo-template/template.yaml`

4.2 Content files under `examples/repo-template/content/`

5. Register the template in catalog config

6. Start the app

7. Verify

Use it

Manifest

Reviews

About

Set up Backstage with GitHub token and repo template

Prerequisites

Steps

1. Scaffold the Backstage app

2. Configure the GitHub token

3. Verify GitHub integration config

4. Create the repo template

4.1 Template definition — examples/repo-template/template.yaml

4.2 Content files under examples/repo-template/content/

5. Register the template in catalog config

6. Start the app

7. Verify

Use it

Manifest

Reviews

4.1 Template definition — `examples/repo-template/template.yaml`

4.2 Content files under `examples/repo-template/content/`