arch-docs/action.yml at main · supermodeltools/arch-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
name: 'Supermodel Arch Docs'
description: 'Generate architecture documentation for any repository using Supermodel'
author: 'Supermodel Tools'
branding:
  icon: 'layers'
  color: 'purple'

inputs:
  supermodel-api-key:
    description: 'Supermodel API key from https://supermodeltools.com'
    required: true
  repo:
    description: 'Repository being analyzed (owner/repo). Overrides GITHUB_REPOSITORY, which cannot be set in Docker container actions when analyzing a different repo.'
    required: false
    default: ''
  site-name:
    description: 'Display name for the docs site (default: repo name + "Architecture Docs")'
    required: false
    default: ''
  base-url:
    description: 'Base URL for the generated site'
    required: false
    default: ''
  output-dir:
    description: 'Output directory relative to workspace'
    required: false
    default: './arch-docs-output'
  templates-dir:
    description: 'Custom templates directory (overrides bundled defaults)'
    required: false
    default: ''
  max-source-files:
    description: 'Cap on source files included in the zip sent to the API (0 = unlimited, default: 3000)'
    required: false
    default: '3000'
  max-entities:
    description: 'Cap on entity pages generated (0 = unlimited, default: 12000). Prioritizes Domain > Subdomain > Directory > File > Class/Type/Function by connectivity.'
    required: false
    default: '12000'

outputs:
  site-path:
    description: 'Absolute path to the built site directory'
  entity-count:
    description: 'Number of entities generated'
  page-count:
    description: 'Total HTML pages generated'

runs:
  using: 'docker'
  image: 'Dockerfile'