Publish TechDocs to S3

Description

Inputs

name	description	type	required	default
entity_name	Backstage entity name (e.g. dai-handbook)	string	true	""
entity_namespace	Backstage entity namespace	string	false	default
entity_kind	Backstage entity kind	string	false	Component
requirements_file	Path to the requirements.txt file	string	false	requirements.txt
python_version	Python version	string	false	3.x
node_version	Node version for techdocs-cli	string	false	20
s3_bucket_name	S3 bucket name for TechDocs storage	string	true	""
aws_region	AWS region	string	false	eu-west-1
aws_role_arn	AWS OIDC role ARN for assuming credentials	string	true	""

Usage

jobs:
  job1:
    uses: dnd-it/github-workflows/.github/workflows/techdocs-publish.yaml@v2
    with:
      entity_name:
      # Backstage entity name (e.g. dai-handbook)
      #
      # Type: string
      # Required: true
      # Default: ""

      entity_namespace:
      # Backstage entity namespace
      #
      # Type: string
      # Required: false
      # Default: default

      entity_kind:
      # Backstage entity kind
      #
      # Type: string
      # Required: false
      # Default: Component

      requirements_file:
      # Path to the requirements.txt file
      #
      # Type: string
      # Required: false
      # Default: requirements.txt

      python_version:
      # Python version
      #
      # Type: string
      # Required: false
      # Default: 3.x

      node_version:
      # Node version for techdocs-cli
      #
      # Type: string
      # Required: false
      # Default: 20

      s3_bucket_name:
      # S3 bucket name for TechDocs storage
      #
      # Type: string
      # Required: true
      # Default: ""

      aws_region:
      # AWS region
      #
      # Type: string
      # Required: false
      # Default: eu-west-1

      aws_role_arn:
      # AWS OIDC role ARN for assuming credentials
      #
      # Type: string
      # Required: true
      # Default: ""

Example

FAQ