Skip to content

docs: add a GitHub Actions section for publishing to Confluence - #46

Merged
willkg merged 3 commits into
mainfrom
docs-github-actions
Jul 23, 2026
Merged

docs: add a GitHub Actions section for publishing to Confluence#46
willkg merged 3 commits into
mainfrom
docs-github-actions

Conversation

@willkg

@willkg willkg commented Jul 23, 2026

Copy link
Copy Markdown
Member

Adds a GitHub Actions section to the README showing how to run markfluence in CI to keep Confluence pages in sync with markdown in the repo.

Covers:

  • CredentialsCONFLUENCE_TOKEN as an encrypted secret, CONFLUENCE_URL/CONFLUENCE_USERNAME as variables or secrets; markfluence reads them straight from the environment (no .env in CI).
  • A push-triggered workflow — checkout → actions/setup-gogo installmarkfluence update docs/**/*.md --force, with a paths: filter and a concurrency group to avoid overlapping publishes.
  • Notes — why --force (fresh-checkout mtimes defeat the skip-unchanged heuristic) and how to scope to changed files instead; non-zero exit on failure and the --json option; and contents: write only if a workflow runs create and commits the persisted page_id back.

Install is via go install github.com/mozilla/markfluence@latest (with a note to pin a tag once releases exist) because no release binaries are published yet. Links to #29 (reusable action) as the follow-up.

Docs-only change.

willkg added 2 commits July 23, 2026 13:21
Document running markfluence in CI to keep Confluence pages in sync with
repo markdown: credentials via secrets/variables, a push-triggered
workflow that installs from source (go install) and runs `update`, and
notes on --force, exit codes, and write permissions. Links to the
reusable-action tracking issue (#29).
Store all three settings as secrets, use a single-document publish example
with an explicit --page-id, and trim the notes to the essentials.
@willkg
willkg force-pushed the docs-github-actions branch from 877abee to ead7465 Compare July 23, 2026 20:21
Reflect the new build stamp (markfluence VERSION (SHA, DATE)) that
landed in #45; note it matches `markfluence --version`.
@willkg
willkg merged commit 24bce64 into main Jul 23, 2026
1 check passed
@willkg
willkg deleted the docs-github-actions branch July 23, 2026 20:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant