automattic/Docspress

Synchronize Markdown docs and WordPress Pages with Gutenberg content and pull requests.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
modeUse publish for GitHub to WordPress, propose for WordPress pull requests, or reconcile for safe two-way synchronization.nopublish
wordpress-urlWordPress API base URL. Use https://public-api.wordpress.com for WordPress.com.nohttps://public-api.wordpress.com
wordpress-siteWordPress.com site ID or domain. Required for WordPress.com API mode.yes
wordpress-access-tokenOAuth bearer token with permission to edit pages on the target WordPress site.yes
docs-dirDirectory containing Markdown docs.nodocs
manifest-fileOptional JSON manifest that defines page order, slugs, parents, titles, and Markdown sources.no""
redirects-fileOptional JSON map of old docs paths to new docs paths or external URLs. Creates managed moved-page placeholders.no""
root-slugSlug for the managed root page.nodocs
root-titleTitle for the managed root page when no root index document supplies one.noDocs
create-h1Add the page title as an H1 block at the top of generated WordPress content.nofalse
rewrite-linksRewrite local Markdown links to the generated WordPress page URLs.notrue
edit-linkAppend an Edit this page on GitHub link to synced Markdown-backed pages.nofalse
edit-link-textLink text for appended source links when edit-link is enabled.noEdit this page on GitHub
github-repositoryGitHub repository for edit links, such as owner/repo. Defaults to GITHUB_REPOSITORY.no""
github-refGitHub branch or ref for edit links. Defaults to GITHUB_REF_NAME.no""
github-server-urlGitHub server URL for edit links. Defaults to GITHUB_SERVER_URL.no""
github-tokenGitHub token used to create or update reverse-sync branches and pull requests.no${{ github.token }}
pull-request-baseBase branch for WordPress-to-GitHub pull requests. Defaults to the repository default branch.no""
pull-request-branchDedicated branch maintained by Docspress for WordPress-to-GitHub changes.nodocspress/wordpress-sync
pull-request-titleOptional pull request and commit title override. Defaults to a conventional docs(scope) title derived from the changed Markdown files.no""
statusWordPress status for created or updated pages, such as draft or publish.nopublish
delete-modeUse trash to move removed docs to Trash, or force to permanently delete them.notrash
dry-runPlan WordPress and GitHub operations without writing to either system.nofalse
namedescription
createdCount of pages created or planned for creation.
updatedCount of pages updated or planned for update.
deletedCount of pages deleted or planned for deletion.
unchangedCount of managed pages already in sync.
conflictsCount of unmanaged or two-sided synchronization conflicts.
proposedCount of repository files proposed from WordPress changes.
skippedWhether the Action skipped a push created by merging its managed reverse-sync branch.
pull-request-numberNumber of the rolling WordPress-to-GitHub pull request, when present.
pull-request-urlURL of the rolling WordPress-to-GitHub pull request, when present.
summary-jsonJSON summary of the sync result.