docspress/action.yml at main · Automattic/docspress · 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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
name: Docspress
description: Synchronize Markdown docs and WordPress Pages with Gutenberg content and pull requests.
author: Fatih Kadir Akin

inputs:
  mode:
    description: Use publish for GitHub to WordPress, propose for WordPress pull requests, or reconcile for safe two-way synchronization.
    required: false
    default: publish
  wordpress-url:
    description: WordPress API base URL. Use https://public-api.wordpress.com for WordPress.com.
    required: false
    default: https://public-api.wordpress.com
  wordpress-site:
    description: WordPress.com site ID or domain. Required for WordPress.com API mode.
    required: true
  wordpress-access-token:
    description: OAuth bearer token with permission to edit pages on the target WordPress site.
    required: true
  docs-dir:
    description: Directory containing Markdown docs.
    required: false
    default: docs
  manifest-file:
    description: Optional JSON manifest that defines page order, slugs, parents, titles, and Markdown sources.
    required: false
    default: ""
  sidebars-file:
    description: Optional YAML or JSON registry that assigns documentation route roots to contextual sidebars.
    required: false
    default: ""
  redirects-file:
    description: Optional JSON map of old docs paths to new docs paths or external URLs. Creates managed moved-page placeholders.
    required: false
    default: ""
  versions-file:
    description: Optional JSON registry defining ordered documentation versions and their root, directory, suffix, or manifest sources.
    required: false
    default: ""
  root-slug:
    description: Slug for the managed root page.
    required: false
    default: docs
  root-title:
    description: Title for the managed root page when no root index document supplies one.
    required: false
    default: Docs
  create-h1:
    description: Add the page title as an H1 block at the top of generated WordPress content.
    required: false
    default: "false"
  rewrite-links:
    description: Rewrite local Markdown links to the generated WordPress page URLs.
    required: false
    default: "true"
  edit-link:
    description: Append an Edit this page on GitHub link to synced Markdown-backed pages.
    required: false
    default: "false"
  edit-link-text:
    description: Link text for appended source links when edit-link is enabled.
    required: false
    default: Edit this page on GitHub
  github-repository:
    description: GitHub repository for edit links, such as owner/repo. Defaults to GITHUB_REPOSITORY.
    required: false
    default: ""
  github-ref:
    description: GitHub branch or ref for edit links. Defaults to GITHUB_REF_NAME.
    required: false
    default: ""
  github-server-url:
    description: GitHub server URL for edit links. Defaults to GITHUB_SERVER_URL.
    required: false
    default: ""
  github-token:
    description: GitHub token used to create or update reverse-sync branches and pull requests.
    required: false
    default: ${{ github.token }}
  pull-request-base:
    description: Base branch for WordPress-to-GitHub pull requests. Defaults to the repository default branch.
    required: false
    default: ""
  pull-request-branch:
    description: Dedicated branch maintained by Docspress for WordPress-to-GitHub changes.
    required: false
    default: docspress/wordpress-sync
  pull-request-title:
    description: Optional pull request and commit title override. Defaults to a conventional docs(scope) title derived from the changed Markdown files.
    required: false
    default: ""
  status:
    description: WordPress status for created or updated pages, such as draft or publish.
    required: false
    default: publish
  delete-mode:
    description: Use trash to move removed docs to Trash, or force to permanently delete them.
    required: false
    default: trash
  dry-run:
    description: Plan WordPress and GitHub operations without writing to either system.
    required: false
    default: "false"

outputs:
  created:
    description: Count of pages created or planned for creation.
  updated:
    description: Count of pages updated or planned for update.
  deleted:
    description: Count of pages deleted or planned for deletion.
  unchanged:
    description: Count of managed pages already in sync.
  conflicts:
    description: Count of unmanaged or two-sided synchronization conflicts.
  proposed:
    description: Count of repository files proposed from WordPress changes.
  skipped:
    description: Whether the Action skipped a push created by merging its managed reverse-sync branch.
  pull-request-number:
    description: Number of the rolling WordPress-to-GitHub pull request, when present.
  pull-request-url:
    description: URL of the rolling WordPress-to-GitHub pull request, when present.
  summary-json:
    description: JSON summary of the sync result.

runs:
  using: node20
  main: dist/index.js