Skip to content

Add generalized docs-publish reusable workflow - #2

Open
Salvialf wants to merge 6 commits into
mainfrom
feat/add-docs-publish
Open

Add generalized docs-publish reusable workflow#2
Salvialf wants to merge 6 commits into
mainfrom
feat/add-docs-publish

Conversation

@Salvialf

@Salvialf Salvialf commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Adds docs-publish.yml, a reusable workflow that syncs a source repository's docs/<lang> content (and shared images/) into jeedom/documentations. Supports two callers: core (destination computed from core/config/version) and plugin (destination computed from plugin_info/info.json's id/category, with alias resolution for travel/financeorganization).

Part of the documentation translation rework tracked in jeedom/documentations#166.

This workflow is only invoked via workflow_call, so merging it has no effect on its own until a caller repo actually uses it.

@Salvialf Salvialf added the enhancement New feature or request label Aug 7, 2026
@Salvialf
Salvialf requested review from Mips2648 and zoic21 August 7, 2026 13:03
…ts docs"

Icon sync now lives in market, uniformly for official and third-party plugins.
This reverts commit 08d7172.
Comment thread .github/workflows/docs-publish.yml
dest_root="documentations/${{ steps.target.outputs.path }}"

for lang in "${locales[@]}"; do
lang_dir="${{ inputs.docs_dir }}/$lang"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On my side (https://github.com/Mips2648/jeedom-plugins-docs/blob/master/.github/workflows/publish-plugin-docs.yml), I choose to sync only fr_FR folder and do the actual translation in the documentation repository.
The added value is that translation memory can be common to all documentations (from all plugins and core), so we make sure that

  1. wording/translations is common and coherent accros all documentions
  2. we reduce number of deepl credits used

On top, this reduce a bit the size of the plugin to download when installed on Jeedom because translated docs is not actually included in the plugin folder

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants