Skip to content

docs(n8n): version-aware signing example and stable/latest aliases - #149

Merged
vitormattos merged 5 commits into
mainfrom
docs/c2-libresign-n8n-polling
Nov 11, 2026
Merged

vitormattos merged 5 commits into
mainfrom
docs/c2-libresign-n8n-polling

Conversation

@vitormattos

@vitormattos vitormattos commented Nov 11, 2026 •

Copy link
Copy Markdown
Member

Scope

Implements the C2 LibreSign + n8n integration example in a separate branch without editing the integration landing pages maintained by front C.

  • Importable inactive n8n workflow: public OCS request creation, explicit notification (once), bounded polling and authenticated Nextcloud WebDAV download of a separately verified path.
  • Version-specific 13/14 (mandatory) and 15/main (requirement) request schemas, using the existing external-email-signers fixtures as reference.
  • Self-contained guide with synthetic PDF, import instructions, credential setup, invitation ownership, API/permission/error semantics, and main-only native event guidance.
  • Node.js static/runtime-of-code-node contract tests; no new endpoints, proprietary callbacks, direct DB access, embedded credentials, production access, or deployment.

Verification

  • node --test examples/n8n/test-workflow.mjs on an isolated, freshly cloned branch: 7 tests passed, 0 failed.
  • No live n8n execution, SMTP delivery, actual signing, browser E2E, real signed-file WebDAV resolution, or cryptographic signature validation was run. These must be checked in a disposable stack before treating it as production-ready.
  • The signed-PDF path is deliberately supplied only after independent permission/path discovery, because public LibreSign OCS does not expose a generic file-id-to-authorized-download endpoint.

Limitations / follow-up

  • The example covers one document / one external signer, not envelopes, mixed rejection policies or multi-signer workflow completion.
  • Polling runs on all versions; main native Webhook Listeners events are documented as optional extension, not claimed as stable13–15 features.
  • After front C is merged, add independently reviewed navigation links from relevant versioned integration pages. No landing pages are changed here.
  • No merge or deploy is requested.

Commits are signed and DCO signed-off.

Follow-up: moving documentation aliases (Nextcloud convention)

  • /latest/ follows unreleased development (/main/); /stable/ follows versions.json.current_stable, not a hardcoded LibreSign major.
  • Static Pages emits per-page HTML redirects for deep links, preserving query strings/fragments and isolated PR-preview prefixes, and serves the pinned OpenAPI JSON/provenance at the matching alias.
  • Full and partial publications regenerate both aliases atomically; previous numeric release URLs and historical redirects remain untouched.
  • The n8n guide now links to stable integration/OpenAPI pages and development-only native webhook documentation through the appropriate aliases. It retains release-specific payload details and directs older installations to the version selector.
  • No overlapping integration landing pages from front C were changed; no merge or deployment was performed.

Additional verification

  • Documentation workflow passed on 2adaf803b376aeb1068c979ea014719d510f8c07 (Sphinx, versioning, links, OpenAPI and publication checks).
  • Preview workflow exposed a test expectation that ignored LIBRESIGN_DOC_BASE_PATH; fixed in the same SHA. Latest preview is still pending at the time of this edit.
  • Regression tests cover deep-page aliases, API JSON and provenance, preview base paths, partial release promotion, alias freshness and missing-file failures.

Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@github-actions

github-actions Bot commented Nov 11, 2026 •

Copy link
Copy Markdown
Contributor
PR Preview Action v1.8.1-4-g2a6da11

QR code for preview link

🚀 View preview at
https://libresign.github.io/site-preview/docs-preview/pr-149/

Built to branch gh-pages at 2026-11-11 02:36 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

Documentation: All versions · LibreSign 16 development manual · Review notes

Preview is separate from production. LibreSign 16 has not been released; the development manual describes the upcoming version.

Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos vitormattos changed the title docs(n8n): add reproducible version-aware signing integration (C2) docs(n8n): version-aware signing example and stable/latest aliases Nov 11, 2026
@vitormattos
vitormattos marked this pull request as ready for review November 11, 2026 02:35
@vitormattos
vitormattos merged commit c2ae3bc into main Nov 11, 2026
3 of 4 checks passed
@vitormattos
vitormattos deleted the docs/c2-libresign-n8n-polling branch November 11, 2026 02:51
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