Changelog beta et Documentation beta

Market Jeedom
, , , , , , , , ,
1

Depuis plusieurs version de Jeedom, si on utilise les versions beta des plugins alors les liens vers la doc et le changelog ne sont pas disponible. Comme indiqué dans la doc développeurs, ce sont des champs obligatoire.
https://doc.jeedom.com/fr_FR/dev/structure_info_json

Pas besoin d’utiliser un changelog différent ou une doc spécial mais au moins mettre le liens des version stable permet de retrouver les boutons :

changelog01
changelog02

"changelog": "https://monPlugin/monChangelog",
  "documentation": "https://monPlugin/documentation",
  "changelog_beta": "https://monPlugin/monChangelog",
  "documentation_beta": "https://monPlugin/documentation",

plugin-mybin
plugin-prixcarburants
plugin-strava

Merci aux développeurs qui en tiendront compte.

2

Merci pour ce rappel,
Y a t-il un tuto pour publier un changelog et une doc différente sur des github_pages différentes en fonction des branches ?

3

Hello,

Normalement tu crées juste un nouveau fichier .md dans le même répertoire que ton changelog.md / index.md, tu peux regarder ici : jMQTT/docs/fr_FR at beta · Domochip/jMQTT · GitHub

Bad

4

Ah oui ok, j’aurais imaginé que chaque branche déploie ses propres pages afin de faciliter les merges.
Ainsi lorsque la beta est mergée dans la stable, la doc beta devient stable sans devoir copier / coller les infos d’un fichier à un autre

5

Oui ce serait mieux, mais le core récup les docs ici :

Et il n’est pas possible d’utiliser un tag ou mettre un numéro de version ou autre chose dedans (ce serait d’ailleurs une amelioration possible).

Sinon tu peux toujours modifier le info.json pour pointer vers une autre doc à chaque version.

6

J’aurai bien aimé aussi, 2 fichiers distinct dans le même repo et faire des copier/coller entre les deux c’est… comment dire :thinking: :face_vomiting: :grimacing:

mais le problème n’est pas chez jeedom, c’est github qui ne permet pas d’avoir des « pages » différentes par branch, c’est par repo … et donc la solution que j’avais imaginée (mais pas encore implémentée, manque de temps, pourtant ca devrait aller assez vite): 1 repo « stable » et 1 fork « beta » (ou vice/versa, c’est p-e plus facile pour la suite dans l’autre sens d’ailleurs, à tester)

=> tu fais tes changements de doc dans le repo beta et ensuite PR dans l’autre (ou fork sync si la doc stable est le fork), chaque repo a son github pages

perso j’ai déjà un repo séparé des plugins pour toutes la doc donc ca fonctionnera bien;
ceux qui garde la doc dans le repo du plugin (et donc github pages sur ce repo aussi), cette idée ne fonctionnera pas (mais je trouve que garder la doc dans le repo du plugin c’est déjà trop désavantageux donc…)

bien sur mettre les 2 liens dans le info.json mais cette partie va de soit

1 « J'aime »