Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Develop #122

Merged
merged 33 commits into from
Dec 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
37b64fb
fix: bump eslint from 9.9.0 to 9.9.1
dependabot[bot] Aug 26, 2024
b2e389f
fix: bump axios from 1.7.4 to 1.7.5
dependabot[bot] Aug 26, 2024
1087384
Apply dist/index.js changes
github-actions[bot] Aug 26, 2024
18e0e95
docs(README): Ajout d'une marche à suivre pour maintenir le repo à jour
ThomDeveo Aug 19, 2024
0953146
docs(README): Modif légère et ajout émojies sur titres
ThomDeveo Aug 19, 2024
ae0998f
docs(README): Ajout du fichier md HOW_TO_MAINTAINS.md et correction d…
ThomDeveo Aug 21, 2024
223e712
docs(README): Correction nom du fichier et ajout petites modifs
ThomDeveo Aug 21, 2024
9a80537
docs(README): Modification Readme
ThomDeveo Aug 23, 2024
8f4e669
docs: :memo: Ajout documentation sur la marche à suivre pour la maint…
ThomDeveo Aug 28, 2024
b68d00e
docs(README): retouche Readme
ThomDeveo Aug 29, 2024
bf86933
fix: bump axios from 1.7.5 to 1.7.7
dependabot[bot] Sep 2, 2024
a60d641
Apply dist/index.js changes
github-actions[bot] Sep 2, 2024
4646935
fix: bump eslint from 9.9.1 to 9.10.0
dependabot[bot] Sep 9, 2024
be0397e
fix: bump eslint from 9.10.0 to 9.11.1
dependabot[bot] Sep 24, 2024
a65fadf
fix: bump @vercel/ncc from 0.38.1 to 0.38.2
dependabot[bot] Sep 25, 2024
2617314
Apply dist/index.js changes
github-actions[bot] Sep 25, 2024
47a71ae
fix: bump eslint from 9.11.1 to 9.12.0
dependabot[bot] Oct 7, 2024
7a748b2
fix: bump @actions/core from 1.10.1 to 1.11.1
dependabot[bot] Oct 7, 2024
723003c
Apply dist/index.js changes
github-actions[bot] Oct 7, 2024
1ff806d
doc: Target `v1.1.2` by default in documentation
adriens Oct 14, 2024
2692f9b
fix: bump eslint from 9.12.0 to 9.13.0
dependabot[bot] Oct 21, 2024
60fd656
fix: bump eslint from 9.13.0 to 9.14.0
dependabot[bot] Nov 4, 2024
f2ca0cf
fix: bump @vercel/ncc from 0.38.2 to 0.38.3
dependabot[bot] Nov 15, 2024
bccc2dc
fix: bump eslint from 9.14.0 to 9.15.0
dependabot[bot] Nov 18, 2024
e2973e1
Apply dist/index.js changes
github-actions[bot] Nov 18, 2024
ef6f7e4
fix: bump axios from 1.7.7 to 1.7.8
dependabot[bot] Nov 26, 2024
ec606e0
Apply dist/index.js changes
github-actions[bot] Nov 26, 2024
15333ff
fix: bump eslint from 9.15.0 to 9.16.0
dependabot[bot] Dec 2, 2024
37b4c0e
fix: bump axios from 1.7.8 to 1.7.9
dependabot[bot] Dec 4, 2024
ec86a3e
Apply dist/index.js changes
github-actions[bot] Dec 4, 2024
e5d5896
fix: bump eslint from 9.16.0 to 9.17.0
dependabot[bot] Dec 16, 2024
518ba86
docs: changement de la version de duckdb
Supervinh Dec 23, 2024
ef2b1c0
Merge pull request #138 from opt-nc/Supervinh-patch-1
Supervinh Dec 23, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 68 additions & 0 deletions HOW_TO_MAINTAIN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# 🚀 Marche à suivre pour maintenir la repo

Dès que possible, lors de l'apparition des PRs de Dependabot, nous devons mettre à jour la GitHub Action des deux dépôts
`setup-duckdb-action` et `setup-duckdb-action-tester`, en accordant une attention particulière à `setup-duckdb-action`.
Le second dépôt sert uniquement à tester le premier. La GitHub Action permet d'installer facilement une version donnée
de DuckDB et de basculer vers une nouvelle version en toute simplicité.
DuckDB est un SGBDR rarement mis à jour, mais les mises à jour incluent généralement des fonctionnalités importantes.

## 📚 Gestion des PRs et vérification

### 🔄 PR Dependabot

Dependabot est un outil qui aide à automatiser la mise à jour des dépendances. la documentation suivante nous explique comment gérer les PRs créées par Dependabot. Dans le 3/4 des cas, les PR sont créées d'une branche features pour être mergée dans develop.
Celles créées d'une branche features vers main sont plus compliquées à gérer, nous préconisons d'importer la branche en local dans son IDE, puis d'appliquer les changements proposés par Dependanbot et faire un commit vers develop.

1. **Vérification de la branche cible :**
- Assurez-vous que la PR cible la branche `develop` et non `main`.

2. **Gestion des mises à jour (Branche features vers develop):**
- 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**, suivez ces étapes :
- Commentez la PR avec la commande : `@dependabot rebase`.
- Dependabot ajoutera un 👍 à votre commentaire.
- Attendez que Dependabot réponde en mettant à la jour la Pull Request, puis mergez la avec `rebase and merge`
- Si **une mise à jour est nécessaire et présente des conflits**, recréez la PR en suivant ces étapes :
- Commentez la Pull Request avec la commande `@dependabot recreate`.
- Attendez que dependabot réponde.
- Si Dependabot ne répond pas après l'appel via commentaire, commentez de nouveau avec `@dependabot recreate`
pour forcer la création d'une nouvelle PR.
- Une fois la PR recréée, mergez-la avec `rebase and merge`.
- Si **Dependabot remarque qu'une dépendance a été upgradée par un mainteneur**, il refuse la montée de version et clôture la PR :
- Si, en discutant avec un membre de l'équipe (Michele Barre ou Adrien Sales), la version ne doit pas être montée, ne rien faire.
- Sinon, relancez la PR avec un `@Dependabot recreate` et mergez la en respectant les consignes vues précédemment.

:warning: Il se peut que deux PR de Dependabot coexistent pour monter de version la même dépendance :
- Ocuppez-vous de la PR avec la proposition de version la plus récente
- Commentez la PR non voulue avec `@dependabot recreate` pour que le bot la clôture de lui même.

3. **Gestion des mises à jour (Branche features vers main):**

:memo: A REDIGER

### 🔐 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`, merger `develop` dans `main`.
Le process de création de release se lance automatiquement. Il est possible de le suivre en allant dans l'onglet Action et
cliquer sur le run en cours. Si le run se termine en erreur, vérifier les logs. En fonction, une simple relance peut rêgler le souci.

### ⚙️ 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 :**
- Une erreur peu fréquente peut être liée à la version du plugin `conventional-changelog` dans ce cas, demandez l'autorisation de changer de version si nécessaire. Consultez l'issue https://github.com/opt-nc/GLIA/issues/1572 pour avoir la marche à suivre.

### 📂 Repos à maintenir avec le même protocole

- [`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`.
- [`tower-deploy-action`](https://github.com/opt-nc/tower-deploy-action) : un GH Action qui intéragit avec les serveurs Tower
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This action installs [`duckdb`](https://github.com/duckdb/duckdb) with the versi
```yaml
uses: opt-nc/setup-duckdb-action@v1.0.8
with:
version: v1.0.0
version: v1.1.3
```

```yaml
Expand Down
Loading
Loading