Armyknife Backstage Installer

A command-line tool for installing and configuring Armyknife Backstage packages.

Features

• Interactive installation of Armyknife Backstage packages
• Automatic configuration of app-config.yaml
• Updates to necessary app files (App.tsx, apis.ts, scaffolder.ts)
• Verification of installation and configuration
• Support for GitHub and GitLab authentication and templates

Available Packages

• @armyknife/backstage-github-auth: GitHub authentication provider for Backstage
• @armyknife/backstage-gitlab-auth: GitLab authentication provider for Backstage
• @armyknife/backstage-github-template: GitHub repository template creation for Backstage
• @armyknife/backstage-gitlab-template: GitLab repository template creation for Backstage

Installation

# Install globally
npm install -g @armyknife/backstage-installer

# Or use npx
npx @armyknife/backstage-installer

Usage

Installing Packages

# Interactive mode
armyknife-backstage install

# Install specific packages
armyknife-backstage install --github-auth --github-template

# Install all packages
armyknife-backstage install --all

# Install in a specific Backstage app directory
armyknife-backstage install --path /path/to/backstage

Configuring Packages

# Interactive mode
armyknife-backstage configure

# Configure specific packages
armyknife-backstage configure --github-auth

# Configure all installed packages
armyknife-backstage configure --all

Updating Packages

# Update all installed packages
armyknife-backstage update

Verifying Installation

# Verify installation and configuration
armyknife-backstage verify

How It Works

The installer performs the following steps:

1. Installation:

   • Detects your Backstage app
   • Installs the selected packages using your package manager (npm or yarn)
   • Copies configuration templates to your app

2. Configuration:

   • Prompts for necessary credentials and settings
   • Updates your app-config.yaml with the provided values
   • Ensures environment variables are properly set up

3. App Integration:

   • Updates App.tsx to include authentication providers
   • Updates apis.ts if present
   • Updates scaffolder.ts to include template actions

4. Verification:

   • Checks that all packages are properly installed
   • Verifies configuration in app-config.yaml
   • Ensures app files are correctly updated

Security Features

The GitHub template package includes support for:

1. Branch protection rules
2. Security scanning (CodeQL, SAST, dependency scanning, container scanning)
3. Dependency updates via Dependabot
4. Comprehensive security documentation
5. CODEOWNERS file for code ownership
6. GitHub issue and PR templates with security considerations
7. GitHub Actions workflows for CI/CD with security checks

Best Practices

When using the GitHub template package:

1. Use standard github.com domain in all URLs and annotations
2. Use the standard github.com/project-slug annotation format in catalog-info.yaml
3. For testing templates without GitHub integration, replace publish and register steps with debug:log actions
4. Simplify GitHub Actions workflows to avoid potential issues with complex configurations
5. Ensure all template variables are properly interpolated in YAML files

License

Apache-2.0