jsv4/DOCX Redlines
Generate Word tracked-changes (redline) documents for .docx files changed in a pull request or push — or for an explicit pair of files — using python-redlines. Optionally renders browser-viewable HTML previews of each redline via Docxodus.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| original | Path to the original .docx for explicit-pair mode. Must be set together with 'modified'. Leave both empty to auto-detect the .docx files changed between two commits instead. | no | "" |
| modified | Path to the modified .docx for explicit-pair mode. | no | "" |
| files | Newline-separated glob pattern(s) selecting which changed .docx files to redline in auto-detect mode (git pathspec globs, case-insensitive). | no | **/*.docx |
| base-ref | Base commit/ref to compare from in auto-detect mode. Must be set together with 'head-ref'. Defaults to the PR base (merge-base with the head when computable) on pull_request events, the pre-push commit on push events, or HEAD~1. | no | "" |
| head-ref | Head commit/ref to compare to in auto-detect mode. | no | "" |
| author | Author name recorded on the generated tracked changes. | no | python-redlines |
| engine | Redline engine: 'docxodus' or 'xmlpowertools'. | no | docxodus |
| comparison | Comparison algorithm for the docxodus engine: 'wmlcomparer' (default) or 'docxdiff'. | no | "" |
| detect-moves | Enable move detection (docxodus engine only): 'true' or 'false'. | no | false |
| output-dir | Directory (relative to the workspace) where redlines are written. | no | redlines |
| html-preview | Render an HTML preview of each redline with the Docx2Html dotnet tool: 'auto' (render when the tool supports it, otherwise warn and skip), 'true' (require it, fail otherwise), or 'false' (skip; no .NET needed). | no | auto |
| summary | Write a job-summary table of the generated redlines: 'true' or 'false'. | no | true |
| upload-artifact | Upload the output directory as a workflow artifact: 'true' or 'false'. | no | true |
| artifact-name | Name of the uploaded artifact. | no | docx-redlines |
| package-version | pip version specifier for python-redlines, e.g. '==0.3.0'. Empty installs the latest release. | no | "" |
| docx2html-version | NuGet version of the Docx2Html dotnet tool. Empty installs the latest. | no | "" |
Outputs
| name | description |
|---|---|
| count | Number of redline documents generated. |
| any-changes | 'true' when at least one .docx change matched (including added/deleted files that cannot be redlined), otherwise 'false'. |
| redlines | JSON array describing each detected change: [{"path", "previous_path", "status", "revisions", "redline", "html"}, ...]. |
| artifact-url | URL of the uploaded artifact (empty when nothing was uploaded). |