Skip to content

Développeurs

Jump to bottom
flyingeek edited this page Feb 12, 2017 · 6 revisions

Il n'est pas possible de modifier les scripts depuis Editorial. Il reste néanmoins possible de personnaliser editolido.

Pour que vos modifications puissent être intégrées à editolido par Pull requests, la commande bumpversion ne doit jamais être utilisée, la modification des versions est privée.

Pour faire une modification:

  • Clonez ce repository
  • créez une nouvelle branche, exemple fix_af011_23Mar2016
  • changer l'url dans l'action d'installation du workflow Editorial, pour tester votre branche. Pour que celà pointe sur le zip de votre branche (https://github.com/votre_pseudo/editolido/archive/fix_af011_23Mar2016.zip). Le workflow Editorial rechargera systematiquement les données de votre branche à chaque utilisation (si MAJ auto ON).

De cette manière, vous pouvez coder, publier le code sur cette branche et tester sur l'iPad.

Pour revenir à la version publiée, remettez l'url de mon repo: https://github.com/flyingeek/editolido/archive/1.0.1.zip (où un champ vide) et positionner MAJ auto ON. Si vous avez vraiment trop bidouillé le code, il faudra peut être effacer le dossier editolido, tuer Editorial et recharger.

Vous pouvez connaitre la version installée sur l'iPad via les logs ou simplement par le fichier editolido.local.cfg.json disponible dans le dossier editolido/data.

Coding Rulez:

  • apply PEP8
  • use UTF-8
  • Use spaces for identation

Outils de développement:

  • sur iPad, je recommande le couple Working Copy / Textastic, faire attention à imposer des espaces comme séparateur et pas des tabs.
  • sur PC/Mac, je recommande PyCharm.

Tests:

editolido utilise pytest. Le repo est testé par TravisCI à chaque commit.

En se plaçant dans le dossier tests/

pytest

Ou pour lancer les tests sans connexion internet:

pytest --offline

Développement sur la branche officielle:

(mémo personnel)

  • publier sur master
  • mettre à jour le README
  • effectuer un bumpversion minor ou bumpversion patch
  • appliquer sur le commit du bump un tag correspondant au numéro de version
  • si nécessaire mettre à jour le markdown de la doc (branche gh-pages), les liens vers les workflows sont dans /workflows
Clone this wiki locally