Backstage Blockchain Actions

This action is for Blockchainradar-powered Backstage instances to have a commit log of changes made to entities by exporting reports to a github repo and metrics to Datadog.

Usage

Inputs

• helper - The helper workflow to invoke.
• backstage_url - The backstage url to pull entities from.
• backstage_entities_repo - The repo to use as fallback if url is unavailable.
• scope - The scope name (usually a Group name) to delimit exported entities by ownership.
• lifecycle = The lifecycle name (usually production) to delimit exported entities by lifecycle.
• template_path - The handlebars templates folder path used for exporting.
• output_path - The output folder path used for compiled templates.

Outputs

• success - A boolean value to indicate whether a workflow was successful or not

Example workflows:

Backstage Export

Create a file at .github/workflows/backstage-export.yml with the following content.

name: Backstage Export

on:
  workflow_dispatch:

jobs:
  export:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - uses: aurora-is-near/backstage-blockchain-actions@v1
        id: export
        with:
          helper: backstage-export
          backstage_url: https://example.com
          template_path: templates/backstage
          output_path: .
  scoped-export:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - uses: aurora-is-near/backstage-blockchain-actions@v1
        id: export
        with:
          helper: backstage-export
          backstage_url: https://example.com
          template_path: templates/backstage
          scope: <group-or-user-name>
          output_path: ./scoped/
  lifecycle-export:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - uses: aurora-is-near/backstage-blockchain-actions@v1
        id: export
        with:
          helper: backstage-export
          backstage_url: https://example.com
          template_path: templates/backstage
          lifecycle: production
          output_path: ./lifecycle/