docs(README): Ajout du fichier md HOW_TO_MAINTAINS.md et correction d…

…e la marche à suivre ref: - #115
opt-nc · Aug 29, 2024 · ae0998f · ae0998f
1 parent 0953146
commit ae0998f
Show file tree

Hide file tree

Showing 2 changed files with 60 additions and 55 deletions.
diff --git a/HOW_TO_MAINTAINS.md b/HOW_TO_MAINTAINS.md
@@ -0,0 +1,59 @@
+# 🚀 Marche à suivre pour maintenir la repo
+
+Dès que possible, lors de l'apparition des PR de dependabot, nous devons mettre à jour la Github Action des deux repos 
+"setup-duckdb-action" et "setup-duckdb-action-tester" avec une attention particulière pour "setup-duckdb-action".  
+La seconde repo sert uniquement à tester la première.
+La Github action va permettre d'installer facilement une version donnée de DuckDB et de basculer facilement vers une nouvelle.  
+`DuckDB` est un SGBDR rarement mis à jour, mais les mises à jour incluent généralement des fonctionnalités importantes.
+
+## 📚 Documentation - Gestion des PRs et Automatisation
+
+### 🔄 PR Dependabot
+
+Dependabot est un outil qui aide à automatiser la mise à jour des dépendances. Voici comment gérer les PRs créées par Dependabot :
+
+1. **Vérification de la branche cible :**
+    - Assurez-vous que la PR cible la branche `develop` et non `main`.
+
+2. **Gestion des mises à jour :**
+    - Si la branche **n'a pas besoin d'être mise à jour**, vous pouvez procéder au merge en utilisant `rebase and merge`
+    - Si la branche **requiert une mise à jour sans conflit**, on met la branche à jour de la manière suivante : 
+      - Commenter la PR avec la commande : `@dependabot rebase`
+      - Dependabot ajoutera un :+1: à votre commentaire.
+      - Attendre que Dependabot réponde en mettant à la jour la Pull Request, puis merger la PR avec `rebase and merge`
+    - Si **une mise à jour est nécessaire et présente des conflits**, nous devons recréer la PR en suivant ces étapes :
+      - Commenter la Pull Request avec la commande `@dependabot recreate`
+      - Attendre le retour de dependabot
+      - Parfois, dependabot ne répond pas après son appel via commentaire, dans ce cas, remettre un commentaire `@dependabot recreate`
+        pour forcer la création d'une nouvelle PR.
+      - Une fois la PR recréée, la merger avec `rebase and merge`
+
+### 🔐 CodeQL
+
+CodeQL est un outil de sécurité qui analyse le code pour identifier des vulnérabilités. Voici ce qu'il faut savoir :
+
+- Si l'action GitHub associée à CodeQL passe, cela signifie que l'analyse de sécurité est validée.
+
+### 🏷️ Release Process
+
+Une fois toutes les PRs fusionnées dans `develop`, suivez ces étapes pour créer une release :
+
+1. Créez une PR de `develop` vers `main`.
+2. Poussez cette PR sans mettre à jour la branche. L'objectif est de faire un merge and commit directement.
+
+### ⚙️ GitHub Actions
+
+Lors de l'utilisation des GitHub Actions, des erreurs peuvent parfois survenir. Voici comment les gérer :
+
+1. **Relancer les jobs en erreur :**
+    - Dans la plupart des cas, relancer simplement le job suffit à résoudre le problème.
+
+2. **Gestion des erreurs persistantes :**
+    - Si l'erreur persiste, consultez le repo [`setup-duckdb-action`](https://github.com/opt-nc/setup-duckdb-action).
+    - L'erreur peut être liée à la version du plugin `conventional-changelog`.
+    - Demandez l'autorisation de changer de version si nécessaire.
+
+### 📂 Repos Associés à maintenir aussi
+
+- [`setup-duckdb-action-tester`](https://github.com/opt-nc/setup-duckdb-action-tester) : Un dépôt dédié aux tests pour le setup de `duckdb`.
+
diff --git a/README.md b/README.md
@@ -31,58 +31,4 @@ uses: opt-nc/setup-duckdb-action@v1.0.8
 - [📖 DuckDB in Action (MEAP)](https://www.manning.com/books/duckdb-in-action)
 - [😎 Awesome DuckDB](https://github.com/davidgasquez/awesome-duckdb)
 - [🛡️ Maintain version at github organization level](https://www.youtube.com/watch?v=cXzkAHPipNw)
-- [🪄 DuckDB sql hack : get things SORTED w/ constraint CHECK](https://dev.to/adriens/duckdb-sql-hack-get-things-sorted-w-constraint-check-46c)
-
-# 🚀 Marche à suivre pour maintenir la repo
-
-## 📚 Documentation - Gestion des PRs et Automatisation
-
-`DuckDB` est rarement mis à jour, mais les mises à jour incluent généralement des fonctionnalités importantes.  
-Il est crucial de maintenir `DuckDB` à jour dans ces cas-là et de surveiller aussi les PR du Dependabot.
-
-### 🔄 PR Dependabot
-
-Dependabot est un outil qui aide à automatiser la mise à jour des dépendances. Voici comment gérer les PRs créées par Dependabot :
-
-1. **Vérification de la branche cible :**
-   - Assurez-vous que la PR cible la branche `develop` et non `main`.
-
-2. **Gestion des mises à jour :**
-   - Si la branche n'a pas besoin d'être mise à jour, vous pouvez procéder au merge.
-   - Si une mise à jour est nécessaire pour éviter les conflits, recréez la pull request en suivant ces étapes :
-      - Commentez la PR avec la commande : `@dependabot rebase`
-      - Dependabot ajoutera un "thumbs up" à votre commentaire.
-      - Attendez que Dependabot réponde en créant une nouvelle pull request.
-
-3. **Problèmes avec Dependabot :**
-   - Parfois, Dependabot ne répond pas après un `rebase`. Si cela se produit, cliquez sur "Create" pour forcer la création de la nouvelle PR.
-
-### 🔐 CodeQL
-
-CodeQL est un outil de sécurité qui analyse le code pour identifier des vulnérabilités. Voici ce qu'il faut savoir :
-
-- Si l'action GitHub associée à CodeQL passe, cela signifie que l'analyse de sécurité est validée.
-
-### 🏷️ Release Process
-
-Une fois toutes les PRs fusionnées dans `develop`, suivez ces étapes pour créer une release :
-
-1. Créez une PR de `develop` vers `main`.
-2. Poussez cette PR sans mettre à jour la branche. L'objectif est de faire un merge and commit directement.
-
-### ⚙️ GitHub Actions
-
-Lors de l'utilisation des GitHub Actions, des erreurs peuvent parfois survenir. Voici comment les gérer :
-
-1. **Relancer les jobs en erreur :**
-   - Dans la plupart des cas, relancer simplement le job suffit à résoudre le problème.
-
-2. **Gestion des erreurs persistantes :**
-   - Si l'erreur persiste, consultez le repo [`setup-duckdb-action`](https://github.com/opt-nc/setup-duckdb-action).
-   - L'erreur peut être liée à la version du plugin `conventional-changelog`.
-   - Demandez l'autorisation de changer de version si nécessaire.
-
-### 📂 Repos Associés à maintenir aussi
-
-- [`setup-duckdb-action-tester`](https://github.com/opt-nc/setup-duckdb-action-tester) : Un dépôt dédié aux tests pour le setup de `duckdb`.
-
+- [🪄 DuckDB sql hack : get things SORTED w/ constraint CHECK](https://dev.to/adriens/duckdb-sql-hack-get-things-sorted-w-constraint-check-46c)