sbordeyne/TechDocs Action
A GitHub Action to generate and publish Backstage TechDocs sites
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| namespace | The Backstage namespace of the entity | no | default |
| kind | The Backstage kind of the entity | no | Component |
| name | The Backstage name of the entity | yes | — |
| publisher-type | The TechDocs publisher type to use (e.g., googleGcs, awsS3, azureBlobStorage) | yes | — |
| bucket-root-path | The root path in the storage bucket where the docs will be published | no | . |
| storage-name | The name of the storage backend (e.g., GCS bucket name, S3 bucket name, Azure container name) | yes | — |
| install-d2 | Whether to install D2 diagramming tool | no | false |
| d2-version | The version of D2 to install | no | latest |
| install-plantuml | Whether to install PlantUML diagramming tool | no | false |
| plantuml-version | The version of PlantUML to install | no | latest |
| mkdocs-plugins | A newline-separated list of mkdocs plugins to install | no | mkdocs-techdocs-core |
| source-dir | Source directory containing mkdocs.yml and docs/ directory. (default: ".") | no | . |
| site-name | The name of the TechDocs site to generate (default: "docs-site") | no | "" |
| aws-role-arn | The ARN of the AWS role to assume for publishing (for awsS3 publisher) | no | "" |
| aws-endpoint | The AWS endpoint to use (for awsS3 publisher) | no | "" |
| aws-proxy | The AWS proxy to use (for awsS3 publisher) | no | "" |
| aws-s3-sse | The AWS S3 server-side encryption method to use (for awsS3 publisher) | no | "" |
| aws-s3-force-path-style | Whether to force path style addressing for S3 (for awsS3 publisher) | no | "" |
| aws-max-attempts | The maximum number of attempts for AWS SDK operations (for awsS3 publisher) | no | "" |
| azure-storage-account-name | The Azure Storage account name (for azureBlobStorage publisher) | no | "" |
| azure-storage-account-key | The Azure Storage account key (for azureBlobStorage publisher) | no | "" |
| openstack-credential-id | The OpenStack credential ID (for openstackSwift publisher) | no | "" |
| openstack-credential-secret | The OpenStack credential secret (for openstackSwift publisher) | no | "" |
| openstack-auth-url | The OpenStack authentication URL (for openstackSwift publisher) | no | "" |
| openstack-swift-url | The OpenStack Swift URL (for openstackSwift publisher) | no | "" |
Outputs
no outputs