Skip to content

Implement Heretto CMS uploader for screenshot synchronization #149

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hawkeyexl merged 5 commits into from
Jan 3, 2026
Merged

Implement Heretto CMS uploader for screenshot synchronization #149

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b78c74c
feat: Implement Heretto CMS uploader for automatic screenshot synchro…
hawkeyexl Dec 18, 2025
b179293
Fix build
hawkeyexl Dec 20, 2025
26b4ce0
Implement screenshot handling and upload functionality
hawkeyexl Dec 22, 2025
a3cc470
feat: Update path resolution to support heretto: URIs
hawkeyexl Dec 30, 2025
534c41f
chore: Update dependencies in package.json and package-lock.json
hawkeyexl Jan 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
249 changes: 249 additions & 0 deletions dist/schemas/config_v3.schema.json
View file
Open in desktop

Large diffs are not rendered by default.

200 changes: 200 additions & 0 deletions dist/schemas/report_v3.schema.json
View file
Open in desktop

Large diffs are not rendered by default.

449 changes: 449 additions & 0 deletions dist/schemas/resolvedTests_v3.schema.json
View file
Open in desktop

Large diffs are not rendered by default.

100 changes: 100 additions & 0 deletions dist/schemas/screenshot_v3.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,56 @@
}
}
]
},
"sourceIntegration": {
"description": "Information about the source integration for this screenshot, enabling upload of changed files back to the source CMS. Set automatically during test resolution for files from integrations.",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "sourceIntegration",
"type": "object",
"additionalProperties": false,
"required": [
"type",
"integrationName"
],
"properties": {
"type": {
"type": "string",
"description": "The type of integration. Currently supported: 'heretto'. Additional types may be added in the future.",
"enum": [
"heretto"
]
},
"integrationName": {
"type": "string",
"description": "The name of the integration configuration in the config file. Used to look up authentication credentials."
},
"fileId": {
"type": "string",
"description": "The unique identifier (UUID) of the file in the source CMS. If not provided, the file will be looked up by path."
},
"filePath": {
"type": "string",
"description": "The path of the file in the source CMS. Used for lookup if fileId is not available."
},
"contentPath": {
"type": "string",
"description": "The local path to the file that references this source. Used for resolving relative paths."
}
},
"examples": [
{
"type": "heretto",
"integrationName": "my-heretto",
"fileId": "8f3ed200-cbba-11e1-ac51-c82a1446d15c",
"filePath": "/db/organizations/example/repositories/docs/images/screenshot.png"
},
{
"type": "heretto",
"integrationName": "my-heretto",
"filePath": "images/screenshot.png",
"contentPath": "/tmp/doc-detective/heretto_abc123/topic.dita"
}
]
}
},
"title": "Capture screenshot (detailed)"
Expand Down Expand Up @@ -383,6 +433,56 @@
}
}
]
},
"sourceIntegration": {
"description": "Information about the source integration for this screenshot, enabling upload of changed files back to the source CMS. Set automatically during test resolution for files from integrations.",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "sourceIntegration",
"type": "object",
"additionalProperties": false,
"required": [
"type",
"integrationName"
],
"properties": {
"type": {
"type": "string",
"description": "The type of integration. Currently supported: 'heretto'. Additional types may be added in the future.",
"enum": [
"heretto"
]
},
"integrationName": {
"type": "string",
"description": "The name of the integration configuration in the config file. Used to look up authentication credentials."
},
"fileId": {
"type": "string",
"description": "The unique identifier (UUID) of the file in the source CMS. If not provided, the file will be looked up by path."
},
"filePath": {
"type": "string",
"description": "The path of the file in the source CMS. Used for lookup if fileId is not available."
},
"contentPath": {
"type": "string",
"description": "The local path to the file that references this source. Used for resolving relative paths."
}
},
"examples": [
{
"type": "heretto",
"integrationName": "my-heretto",
"fileId": "8f3ed200-cbba-11e1-ac51-c82a1446d15c",
"filePath": "/db/organizations/example/repositories/docs/images/screenshot.png"
},
{
"type": "heretto",
"integrationName": "my-heretto",
"filePath": "images/screenshot.png",
"contentPath": "/tmp/doc-detective/heretto_abc123/topic.dita"
}
]
}
},
"title": "Capture screenshot (detailed)"
Expand Down
50 changes: 50 additions & 0 deletions dist/schemas/sourceIntegration_v3.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "sourceIntegration",
"description": "Information about the source integration for a file, enabling upload of changed files back to the source CMS.",
"type": "object",
"additionalProperties": false,
"required": [
"type",
"integrationName"
],
"properties": {
"type": {
"type": "string",
"description": "The type of integration. Currently supported: 'heretto'. Additional types may be added in the future.",
"enum": [
"heretto"
]
},
"integrationName": {
"type": "string",
"description": "The name of the integration configuration in the config file. Used to look up authentication credentials."
},
"fileId": {
"type": "string",
"description": "The unique identifier (UUID) of the file in the source CMS. If not provided, the file will be looked up by path."
},
"filePath": {
"type": "string",
"description": "The path of the file in the source CMS. Used for lookup if fileId is not available."
},
"contentPath": {
"type": "string",
"description": "The local path to the file that references this source. Used for resolving relative paths."
}
},
"examples": [
{
"type": "heretto",
"integrationName": "my-heretto",
"fileId": "8f3ed200-cbba-11e1-ac51-c82a1446d15c",
"filePath": "/db/organizations/example/repositories/docs/images/screenshot.png"
},
{
"type": "heretto",
"integrationName": "my-heretto",
"filePath": "images/screenshot.png",
"contentPath": "/tmp/doc-detective/heretto_abc123/topic.dita"
}
]
}
Loading