eric/distributor
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 7 Wiki Activity

Add Markdown HTML publication

Browse Source
This commit is contained in:
Eric Rakestraw
2026-05-31 02:28:48 +00:00
parent e296361042
commit 5408f14195
21 changed files with 628 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/operations.md
View File

@@ -14,6 +14,12 @@ Run the local publication:
go run ./cmd/distributor run --config examples/local-publish.yml
```
Run the local HTML publication:
```sh
go run ./cmd/distributor run --config examples/local-html.yml
```
## Filesystem layout
Source bundles are discovered beneath the configured local source root. Destination bundle paths preserve the source bundle path relative to that source root.
@@ -22,7 +28,7 @@ The maintained example writes under `workspace/`, which is ignored by Git.
## Destination state
Each published destination bundle contains `.distributor.json`. This state file records the source manifest and copied source outputs. It is the authoritative marker that a destination path is managed by `distributor`.
Each published destination bundle contains `.distributor.json`. This state file records the source manifest, copied source outputs, and generated outputs. It is the authoritative marker that a destination path is managed by `distributor`.
`manifest.json` from the source bundle is not copied as destination state.
@@ -36,4 +42,4 @@ If a write fails during local publication, `distributor` removes outputs written
## Caveats
Only local-to-local source-file publication is implemented. SSH, S3, HTML generation, notification, and force overwrite behavior are not implemented.
Only local-to-local publication is implemented. SSH, S3, notification, and force overwrite behavior are not implemented.