Création d'une revue de presse#

Concrètement, une revue de presse est un fichier markdown, nommé d'une certaine façon, stocké dans le dossier content/rdp/ et organisé en sections dans lesquelles les contributeur/ices viennent ensuite insérer leurs "news". Le processus de contribution est bâti autour de la logique de Git.

Avant d'ouvrir la revue de presse aux contributions, il est donc nécessaire de créer :

1. une branche dédiée dans le dépôt du site
2. le fichier Markdown avec la structure type
3. la Pull Request permettant de visualiser les différentes contributions puis de publier (fusionner) la revue de presse une fois finalisée

Il est possible de créer une revue de presse de plusieurs façons détaillées dans cette page. Choisissez selon vos préférences et votre niveau de confort avec les outils Git/GitHub :

• en déclenchant la création automatique en 3 clics depuis l'interface web de GitHub
• en utilisant l'interface web de GitHub
• en utilisant le script intégré au dépôt
• en utilisant Git en ligne de commande

Automatiquement via GitHub#

L'outillage et la logique de publication de Geotribu sont largement basés sur Git et la plateforme GitHub. Nous utilisons notamment les principes de l'intégration et du déploiement continus (CI/CD pour les intimes).

La méthode la plus simple pour créer une nouvelle revue de presse est donc d'utiliser le workflow " New GeoRDP" disponible sur GitHub :

1. Se rendre sur l'onglet Actions et sélectionner le workflow " New GeoRDP" ou cliquer ici
2. Cliquer sur Run workflow
3. Entrer les infos demandées :
   • branche : master
   • date de la revue de presse : doit être au format YYYY-MM-DD et pointer sur un vendredi
   • cocher la case pour envoyer automatiquement une notification sur Matrix
4. Cliquer sur le bouton vert Run workflow.

Après une trentaine de secondes, on obtient :

• une branche dédiée pour la revue de presse
• un fichier Markdown avec la structure type et la date de publication
• une Pull Request basée sur le modèle
• une notification dans le canal Matrix de Geotribu pour informer la communauté

Voici une vidéo illustrant le déroulé :

Manuellement via l'interface web de GitHub#

Il est également possible d'utiliser l'ancienne procédure manuelle.
Voici une vidéo retraçant les étapes de création d'une revue de presse via l'interface web de GitHub :

Utiliser le script intégré#

Si Git est installé et que vous disposez d'un terminal Bash et du dépôt du site localement, il est possible d'utiliser le script intégré :

# stocker la date de la RDP au format YYYY-MM-DD
DATE_RDP=2022-01-07

# exécuter le script
scripts/new_rdp.sh $DATE_RDP

# pousser vers le dépôt distant
git pull
git checkout -b rdp/$DATE_RDP
git add content/rdp/
git commit -am "Crée la GeoRDP $DATE_RDP"
git push origin rdp/$DATE_RDP

# ouvrir la Pull Request sur GitHub
xdg-open "https://github.com/geotribu/website/compare/master...rdp/$DATE_RDP?quick_pull=1&template=RDP.md"

Ne pas oublier ensuite de :

1. se rendre sur GitHub pour créer la Pull Request :
   1. cliquer sur le bouton vert New pull request
   2. sélectionner votre branche dans la liste déroulante à droite (compare:)
2. sur le canal Matrix pour notifier l'équipe et la communauté

Processus détaillé avec Git en ligne de commande#

Cette partie explique chaque étape du processus de création d'une revue de presse pour comprendre ce que font les automatisations présentées au-dessus (script, GitHub Actions...).

1. Créer la branche de la revue de presse#

La première étape consiste à créer une branche Git pour la revue de presse. Elle n'est réalisable que par une personne disposant d'un compte GitHub ayant les droits en écriture sur le dépôt du site : https://github.com/geotribu/website/.

Il est important de respecter la convention de nommage rdp/YYYY-MM-DD où :

• YYYY est l'année de publication
• MM le mois de publication prévisionelle
• DD le jour de publication prévisionnelle

Exemple si la GeoRDP devait être publiée le 17 septembre 2021 : rdp/2021-09-17.

1. Mettre à jour le dépôt local :

   git pull --prune origin master
   

2. Vérifier qu'une branche n'existe pas déjà en listant les branches du dépôt sur GitHub en filtrant sur la structure de nommage :

   git branch -r -l 'origin/rdp/*'
   

3. Créer la nouvelle branche :

   $ git checkout -b rdp/2021-09-17
   Switched to a new branch 'rdp/2021-09-17'
   

4. Pousser la branche sur GitHub :

   $ git push origin rdp/2021-09-17
   Total 0 (delta 0), réutilisés 0 (delta 0), réutilisés du pack 0
   remote:
   remote: Create a pull request for 'rdp/2021-09-17' on GitHub by visiting:
   remote:      https://github.com/geotribu/website/pull/new/rdp/2021-09-17
   remote:
   To github.com:geotribu/website.git
   * [new branch]        rdp/2021-09-17 -> rdp/2021-09-17
   

2. Créer le fichier de la revue de presse#

Afin d'accueillir les news, il s'agit de créer un fichier en respectant l'organisation et le nommage des fichiers : content/rdp/YYYY/rdp_YYYY-MM-DD.md où :

• YYYY est l'année de publication
• MM le mois de publication prévisionelle
• DD le jour de publication prévisionnelle

Exemple si la GeoRDP devait être publiée le 17 septembre 2021 : content/rdp/2021/rdp_2021-09-17.md.

Structure type et modèle#

Les revues de presse sont structurées de la même façon d'une édition à l'autre, facilitant leur consultation et les traitements automatiques. Le plus simple est donc de copier/coller la structure type à partir du modèle maintenu à jour sur GitHub

Ensuite, il faut mettre à jour certains éléments dans l'en-tête du fichier, mettre à jour les valeurs de title:, date: et description:. L'image est à choisir plutôt juste avant la publication en piochant dans celles des news retenues (voir aussi cette page sur les images).

Les lignes concernées sont surlignées ci-dessous (attention, cela peut varier selon le modèle utilisé) :

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

---
title: "Revue de presse du 21 août 2021"
authors:
    - Geotribu
categories:
    - revue de presse
date: 2021-08-21
description: "Description de 160 caractères maximum qui résume la RDP. Cette description est présente dans le flux RSS, la newsletter, les moteurs de recherche, en page d'accueil... "
image: "Image d'illustration de la RDP qui sert ensuite dans la mise en avant : réseaux sociaux, flux RSS... 400x800 en PNG"
license: default
robots: index, follow
tags:
    - tag 1
    - tag 2
    - ...
---

[...]

3. Pousser le fichier sur GitHub#

Enfin, il faut pousser le fichier sur la branche créée sur GitHub.

git add content/rdp/
git commit -am "Crée la GeoRDP du DD MM YYYY"
git push origin rdp/YYYY-MM-DD

Commentaires