Skip to content

Commit

Permalink
Merge pull request #23 from PnX-SI/dev
Browse files Browse the repository at this point in the history
Dev > Main / 1.1.0
  • Loading branch information
camillemonchicourt authored Jun 2, 2023
2 parents e3d0dd4 + 192524d commit 1377dbc
Show file tree
Hide file tree
Showing 160 changed files with 4,657 additions and 3,568 deletions.
25 changes: 25 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Lint

on: [push, pull_request]

jobs:
backend:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Backend code formatting check (Black)
uses: psf/black@stable

frontend:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Frontend code formatting check (Prettier)
uses: creyD/[email protected]
with:
dry: True
prettier_options: --config frontend/.prettierrc --ignore-path frontend/.prettierignore --check frontend/**/*.ts
47 changes: 45 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,43 @@
# Changelog

## 1.0.0 (2022-10-03)
## 1.1.0 - Taillefer (2023-06-02)

**🚀 Première release 🚀**
Nécessite la version 2.12.0 (ou plus) de GeoNature.

**🚀 Nouveautés**

- Compatibilité avec GeoNature 2.12 : Angular 15, configuration dynamique, configuration centralisée
- Packaging du module (#7)
- Gestion de la BDD du module avec Alembic
- Externalisation du RefGeo
- Corrections et refactorisation diverses

**🐛 Corrections**

- Définition du SRID des champs de géométrie dans la BDD (#13)
- Correction du fonctionnement quand le module ne contient encore aucune zone humide (#10)
- Correction du fichier d'exemple de configuration (#9)
- Correction du moteur de recherche multi-critères dans la recherche sur les bassins versants (#14)
- Correction du menu déroulant du filtre sur les menaces (#19)

**⚠️ Notes de version**

- Si vous mettez à jour le module indépendamment de GeoNature, suivez la procédure classique de mise à jour du module, mais sans exécuter les évolutions de la BDD dans un premier temps (`geonature install-gn-module ~/gn_module_ZH ZONES_HUMIDES --upgrade-db=false`)
- Si vous mettez à jour le module en même temps que vous mettez à jour GeoNature, suivez la nouvelle procédure de mise à jour de GeoNature qui consiste uniquement à télécharger la nouvelle version du module, la dézipper, la renommer (ou uniquement de faire un `git pull` depuis le dossier du module si celui-ci a été installé avec git) puis lancer le script de migration de GeoNature qui se chargera de mettre à jour les modules en même temps
- Exécutez ensuite la commande suivante afin d’indiquer à Alembic que votre base de données est dans l'état de la version 1.0.0 et appliquer automatiquement les évolutions pour la passer dans l'état de la version 1.1.0 :
```
geonature db stamp 01cb1aaa2062
geonature db upgrade zones_humides@head
```

**📝 Contributeurs**

Cette version a été réalisée grâce à la contribution du Parc national des Écrins et de Natural Solutions.
Merci à @TheoLechemia, @mvergez, @JulienCorny, @cen-cgeier et @camillemonchicourt.

## 1.0.0 - Camargue (2022-10-03)

**🚀 Première release**

Version fonctionnelle permettant :
- La création de nouvelles zones humides
Expand All @@ -16,3 +51,11 @@ Version fonctionnelle permettant :
- L'export au format pdf d'une fiche descriptive synthétique
- L'export au format csv des espèces à statut (évaluation/protection/menace)
observées dans le périmètre de la zone humide.

**⚠️ Notes de version**

Compatible avec les versions 2.9.1 et 2.9.2 de GeoNature

**Financements**

Cette première version a été commandée par le [PNR du Luberon](https://www.parcduluberon.fr/) au nom du [SIT interparcs PACA](http://geo.pnrpaca.org/), financée par le [PNR du Luberon](https://www.parcduluberon.fr/), le [PNR de la Sainte-Baume](https://www.pnr-saintebaume.fr/) et [Natural Solutions](https://www.natural-solutions.eu/), et réalisée par [Natural Solutions](https://www.natural-solutions.eu/).
3 changes: 3 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
include VERSION
include README.md
include requirements.in
93 changes: 47 additions & 46 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,74 +20,75 @@ Ne pas oublier de redémarrer GeoNature :

## **Installation**

- Définir le nom de la branche
- Télécharger puis renommer la version souhaitée du module :

```bash
BRANCHNAME='master'
```
```
cd
wget https://github.com/PnX-SI/gn_module_ZH/archive/X.Y.Z.zip
unzip X.Y.Z.zip
rm X.Y.Z.zip
mv gn_module_ZH-X.Y.Z gn_module_ZH
```

- Copier le dépôt
- Exécuter la commande GeoNature d'installation de module

```bash
cd /home/`whoami`
git clone https://github.com/PnX-SI/gn_module_ZH.git
cd /home/`whoami`/gn_module_ZH
git checkout $BRANCHNAME
```
```
source ~/geonature/backend/venv/bin/activate
geonature install-gn-module ~/gn_module_ZH ZONES_HUMIDES
deactivate
sudo systemctl restart geonature
```

- Exécuter la commande GeoNature d'installation de module
Vous pouvez modifier la configuration du module en créant un fichier `zones_humides_config.toml` dans le dossier `config` de GeoNature, en vous inspirant
du fichier `zones_humides_config.toml.example` et en surcouchant uniquement les paramètres que vous souhaitez.

```bash
cd /home/`whoami`/geonature/backend
source venv/bin/activate
geonature install_gn_module /home/`whoami`/gn_module_ZH /zones_humides
```
Voir [ici](/doc/admin.md) la documentation des paramètres de configuration du module pour les administrateurs.

- Facultatif : modifier les paramètres par défaut du module :
## **Mise à jour**

```bash
nano /home/`whoami`/gn_module_ZH/config/conf_schema_toml.py
```
- Téléchargez la nouvelle version du module

Après avoir modifié le fichier de paramètres, faire une mise à jour :
```
wget https://github.com/PnX-SI/gn_module_ZH/archive/X.Y.Z.zip
unzip X.Y.Z.zip
rm X.Y.Z.zip
```

```bash
cd /home/`whoami`/geonature/backend
source venv/bin/activate
geonature update_module_configuration zones_humides
```
- Renommez l'ancien et le nouveau répertoire

Voir [ici](/doc/admin.md) pour documentation des paramètres de configuration du module pour les administrateurs
```
mv ~/gn_module_ZH ~/gn_module_ZH_old
mv ~/gn_module_ZH-X.Y.Z ~/gn_module_ZH
```

## **Désinstallation**
- Si vous avez encore votre configuration du module dans le dossier `config` du module, copiez le vers le dossier de configuration centralisée de GeoNature :

- Exécuter la commande GeoNature de désactivation de module
```
cp ~/gn_module_ZH_old/config/conf_gn_module.toml ~/geonature/config/zones_humides_config.toml
```

```bash
cd /home/`whoami`/geonature/backend
source venv/bin/activate
geonature deactivate_gn_module zones_humides
```
- Lancez la mise à jour du module

- Suppression des données dans plusieurs tables de la base de données
```
source ~/geonature/backend/venv/bin/activate
geonature install-gn-module ~/gn_module_ZH ZONES_HUMIDES
sudo systemctl restart geonature
```

```bash
SQL_PORT=5432
GEONAT_USER=geonatadmin
GEONAT_DB=geonature2db
```
## **Désinstallation**

{- Attention, commandes irréversibles de suppression de données en base de données (à faire uniquement si vous êtes certain de savoir ce que vous faites !) -}
- Suppression des données dans plusieurs tables de la base de données

```bash
sudo psql -h localhost -p $SQL_PORT -U $GEONAT_USER -d $GEONAT_DB -b -f "/home/`whoami`/gn_module_ZH/data/desinstall.sql"
cd /home/`whoami`/geonature/backend
source venv/bin/activate
geonature db downgrade zones_humides@base
pip uninstall gn_module_zh
```

- Suppression des répertoires sur le serveur

{- Attention, commandes irréversibles de suppression de fichiers sur le serveur (à faire uniquement si vous êtes certain de savoir ce que vous faites !) -}

```bash
rm -rf /home/`whoami`/gn_module_ZH
rm -rf /home/`whoami`/geonature/external_modules/zones_humides
rm -rf /home/`whoami`/geonature/frontend/external_modules/zones_humides
```
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.0.0
1.1.0
Loading

0 comments on commit 1377dbc

Please sign in to comment.