confluence-md/action.yml at main · 7nohe/confluence-md · 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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
name: 'Confluence MD'
description: 'Convert Markdown (GFM) to Confluence Cloud storage format and update a page'
author: '7nohe'

branding:
  icon: 'file-text'
  color: 'blue'

inputs:
  confluence_base_url:
    description: 'Confluence base URL (e.g., https://example.atlassian.net)'
    required: true
  page_id:
    description: 'Confluence page ID (fallback if frontmatter missing)'
    required: false
  space_key:
    description: 'Confluence space key (creates new page if no page_id)'
    required: false
  parent_page_id:
    description: 'Parent page ID for new pages'
    required: false
  write_page_id:
    description: 'Write created page ID back to frontmatter'
    required: false
    default: 'true'
  email:
    description: 'Confluence account email'
    required: true
  api_token:
    description: 'Confluence API token'
    required: true
  source:
    description: 'Markdown file or directory path'
    required: true
  attachments_base:
    description: 'Base directory for resolving relative image paths (defaults to source directory)'
    required: false
  title_override:
    description: 'Override page title'
    required: false
  frontmatter_page_id_key:
    description: 'Frontmatter key used to extract the page ID'
    required: false
    default: 'confluence_page_id'
  image_mode:
    description: 'Image handling mode: upload or external'
    required: false
    default: 'upload'
  download_remote_images:
    description: 'Download remote images and upload as attachments'
    required: false
    default: 'false'
  mermaid_macro:
    description: 'Macro name emitted for mermaid code fences. Set to match the Mermaid app installed in your Confluence site (e.g. mermaid-cloud).'
    required: false
    default: 'mermaid'
  skip_if_unchanged:
    description: 'Skip update when storage output is identical'
    required: false
    default: 'true'
  exclude:
    description: 'Glob patterns to exclude files in directory mode (comma or newline separated, e.g., "**/README.md,docs/draft/**")'
    required: false
    default: ''
  dry_run:
    description: 'Build output but do not update Confluence'
    required: false
    default: 'false'
  notify_watchers:
    description: 'Accepted but currently ignored'
    required: false
    default: 'false'
  user_agent:
    description: 'HTTP user agent'
    required: false
    default: 'confluence-md'

outputs:
  page_url:
    description: 'URL of the updated Confluence page'
  page_id:
    description: 'ID of the updated Confluence page'
  version:
    description: 'New version number of the page'
  updated:
    description: 'Whether the page was actually updated (true/false)'
  created:
    description: 'Whether a new page was created (true/false)'
  attachments_uploaded:
    description: 'Number of attachments uploaded'
  content_hash:
    description: 'Hash of the generated storage content'
  total_files:
    description: 'Total number of Markdown files processed in directory mode'
  succeeded_files:
    description: 'Number of files processed successfully in directory mode'
  failed_files:
    description: 'Number of files that failed in directory mode'
  updated_files:
    description: 'Number of files updated in directory mode'
  attachments_uploaded_total:
    description: 'Total number of attachments uploaded in directory mode'
  results_json:
    description: 'JSON array of per-file results in directory mode'
  failures_json:
    description: 'JSON array of per-file failures in directory mode'
  skipped_files:
    description: 'Number of files skipped (no page ID) in directory mode'
  skipped_json:
    description: 'JSON array of per-file skipped entries in directory mode'

runs:
  using: 'node24'
  main: 'dist/index.js'