Skip to content

Commit 8a1e223

Browse files
committed
Complétion
1 parent e166515 commit 8a1e223

File tree

1 file changed

+29
-6
lines changed

1 file changed

+29
-6
lines changed

content/contribuer/rdp/create_rdp.md

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: "Créer une revue de presse"
33
authors:
44
- Geotribu
5+
- Julien MOURA
56
categories:
67
- contribution
78
date: "2021-09-30 10:20"
@@ -10,6 +11,9 @@ image: "https://cdn.geotribu.fr/img/articles-blog-rdp/collaboration_world.png"
1011
license: default
1112
tags:
1213
- contribuer
14+
- GitHub
15+
- GitHub Actions
16+
- GitHub Workflow
1317
- guide
1418
- GeoRDP
1519
- workflow
@@ -19,7 +23,15 @@ tags:
1923

2024
![icône news générique](https://cdn.geotribu.fr/img/internal/icons-rdp-news/news.png "icône news générique"){: .img-rdp-news-thumb }
2125

22-
La création d'une revue de presse passe par la création d'une branche dédiée dans le dépôt du site et du fichier Markdown qui contiendra les news dans une structure type. Il est possible de créer en utilisant Git en ligne de commande ou via l'interface web de GitHub.
26+
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". L processus de contribution est bâti autour de la logique de Git.
27+
28+
Avant d'ouvrir la revue de presse aux contributions, il est donc nécessaire de créer :
29+
30+
1. une branche dédiée dans le dépôt du site
31+
2. le fichier Markdown avec la structure type
32+
3. la Pull Request permettant de visualiser les différentes contributions puis de publier (fusionner) la revue de presse une fois finalisée
33+
34+
Il est possible de créer en utilisant Git en ligne de commande ou via l'interface web de GitHub.
2335

2436
!!! info "Zone réservée"
2537
La création d'une nouvelle revue de presse nécessite de disposer des droits d'écriture sur le dépôt GitHub : [{{ config.repo_name }}]({{ config.repo_url }}).
@@ -28,22 +40,33 @@ La création d'une revue de presse passe par la création d'une branche dédiée
2840

2941
![icône GitHub Actions](https://cdn.geotribu.fr/img/logos-icones/divers/github_actions.png "GitHub Actions"){: .img-rdp-news-thumb }
3042

31-
La méthode la plus simple de créer une nouvelle revue de presse est d'utiliser le workflow *:newspaper2: New GeoRDP* disponible sur GitHub :
43+
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](https://fr.wikipedia.org/wiki/CI/CD)).
3244

33-
1. Se rendre sur l'onglet `Actions` et sélectionner le workflow *:newspaper2: New GeoRDP* ou [cliquer ici]({{ config.repo_url }}actions/workflows/manual_new_rdp.yml)
45+
La méthode la plus simple pour créer une nouvelle revue de presse est donc d'utiliser le *workflow* ":newspaper2: New GeoRDP" disponible sur GitHub :
46+
47+
1. Se rendre sur l'onglet `Actions` et sélectionner le *workflow* ":newspaper2: New GeoRDP" ou [cliquer ici]({{ config.repo_url }}actions/workflows/manual_new_rdp.yml)
3448
2. Cliquer sur `Run workflow`
3549
3. Entrer les infos demandées :
3650
- branche : `master`
3751
- date de la revue de presse : doit être au format `YYYY-MM-DD` et pointer sur un vendredi
3852
- choisir d'envoyer automatiquement une notification sur Slack
3953
4. Cliquer sur le bouton vert `Run workflow`.
4054

55+
Après une trentaine de secondes, on obtient :
56+
57+
- une branche dédiée pour la revue de presse
58+
- un fichier Markdown avec la structure type et la date de publication
59+
- une Pull Request basée sur le modèle
60+
- une notification Slack pour informer l'équipe
61+
4162
<!-- markdownlint-disable MD046 -->
4263
!!! abstract "Prérequis"
43-
La bonne exécution du workflow dépend de ces éléments configurés au préalable sur le dépôt :
64+
La bonne exécution du workflow dépend de ces éléments :
4465

66+
- la revue de presse ou sa branche n'ont pas déjà été créées par ailleurs
67+
- le modèle de revue de presse est à jour et bien présent : `content/rdp/templates/template_rdp.md`
4568
- le modèle de Pull Request est bien présent : `.github/PULL_REQUEST_TEMPLATE.md`
46-
- que l'URL du webhook de Slack (`SLACK_WEBHOOK_URL`) est bien configuré dans [les secrets du dépôt]({{ config.repo_url }}settings/secrets/actions) (cliquer [ici pour administrer le webhook Slack](https://api.slack.com/apps/A020C9Q93BK/incoming-webhooks/))
69+
- l'URL du webhook de Slack (`SLACK_WEBHOOK_URL`) est bien configurée dans [les secrets du dépôt]({{ config.repo_url }}settings/secrets/actions) (cliquer [ici pour administrer le webhook Slack](https://api.slack.com/apps/A020C9Q93BK/incoming-webhooks/))
4770
<!-- markdownlint-enable MD046 -->
4871

4972
### Utiliser localement le script intégré localement
@@ -81,7 +104,7 @@ Voici une vidéo retraçant les étapes de création d'une revue de presse via l
81104

82105
## Processus détaillé
83106

84-
Cette partie permet de comprendre chaque étape du processus de création d'une revue de presse.
107+
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...).
85108

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

0 commit comments

Comments
 (0)