Skip to content

Commit

Permalink
Préparation à la publication de la 1.7.1
Browse files Browse the repository at this point in the history
* Complétion du Changelog
* Adaptation aux changements du site de documentation
  • Loading branch information
Dolite committed Jul 10, 2023
1 parent e7a8c51 commit 7bdbc8b
Show file tree
Hide file tree
Showing 5 changed files with 55 additions and 29 deletions.
25 changes: 13 additions & 12 deletions .github/workflows/build-and-release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -182,25 +182,26 @@ jobs:
- name: Add pages from templates
run: |
sed "s#__version__#${{ github.ref_name }}#" templates/TESTS.template.md >docs/versions/${{ github.ref_name }}/TESTS.md
sed "s#__version__#${{ github.ref_name }}#" templates/DOCUMENTATION.template.md >docs/versions/${{ github.ref_name }}/DOCUMENTATION.md
sed "s#__version__#${{ github.ref_name }}#" templates/CHANGELOG.template.md >docs/versions/${{ github.ref_name }}/CHANGELOG.md
cat artifact/CHANGELOG.md >>docs/versions/${{ github.ref_name }}/CHANGELOG.md
sed "s#__version__#${{ github.ref_name }}#" templates/README.template.md >docs/versions/${{ github.ref_name }}/README.md
cat artifact/README.md >>docs/versions/${{ github.ref_name }}/README.md
sed -i "s#x.y.z#${{ github.ref_name }}#g" docs/versions/${{ github.ref_name }}/README.md
sed "s#__version__#${{ github.ref_name }}#" templates/index.template.md >docs/index.md
echo "# Versions" >docs/versions.md
echo "" >>docs/versions.md
for v in `ls -t docs/versions | grep -v latest`; do sed "s#__version__#$v#" templates/versions.template.md >>docs/versions.md; done
sed "s#__version__#${{ github.ref_name }}#" templates/mkdocs.template.yml >mkdocs.yml
sed "s#__version__#${{ github.ref_name }}#" templates/tests.template.md >docs/versions/${{ github.ref_name }}/tests.md
sed "s#__version__#${{ github.ref_name }}#" templates/documentation.template.md >docs/versions/${{ github.ref_name }}/documentation.md
sed "s#__version__#${{ github.ref_name }}#" templates/index-version.template.md >docs/versions/${{ github.ref_name }}/index.md
cat artifact/README.md >>docs/versions/${{ github.ref_name }}/index.md
sed -i "s#x.y.z#${{ github.ref_name }}#g" docs/versions/${{ github.ref_name }}/index.md
cp templates/index-versions.template.md docs/versions/index.md
sed "s/^## \(.*\)$/## \1 \n\n[➔ Lien vers la documentation](\1\/index.md) /" artifact/CHANGELOG.md >>docs/versions/index.md
sed "s#__version__#${{ github.ref_name }}#" templates/latest.template.html >docs/versions/latest/index.html
rm -r artifact
- name: Publish on gh-pages branch
run: |
git config user.name github-actions
git config user.email [email protected]
git add -v docs/versions/${{ github.ref_name }}/ docs/versions/latest/ docs/index.md docs/versions.md
git add -v docs/versions/${{ github.ref_name }}/ docs/versions/latest/ docs/versions/index.md mkdocs.yml
git commit -m "Add documentation for version ${{ github.ref_name }}"
git push
Expand Down
38 changes: 38 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,41 @@
## 1.7.0

### [Added]

* Raster
* Classe RasterSet, réprésentant une collection d'objets de la classe Raster, avec des informations supplémentaires
* Méthodes d'import et export des informations extraites par une instance RasterSet, au travers d'un descripteur (fichier ou objet json, voire sortie standard)
* Documentation interne
* Tests unitaires pour la classe RasterSet
* Classe Raster : constructeur à partir des paramètres

* Pyramid
* Fonction de calcul de la taille d'une pyramide
* Générateur de lecture de la liste du contenu

* Storage
* Fonction de calcul de la taille des fichiers d'un chemin selon le stockage
* Ajout de la copie de HTTP vers FILE/S3/CEPH
* Ajout de la fonction de lecture d'un fichier HTTP, de l'existence d'un fichier HTTP et du calcul de taille d'un fichier HTTP

### [Changed]

* Raster
* Homogénéisation du code
* Mise en conformité PEP-8
* test_Raster
* Homogénéisation du code
* Mise en conformité PEP-8
* Utils
* Mise en conformité PEP-8 des fonctions `compute_bbox` et `compute_format`


### [Fixed]

* Utils
* Correction d'un nom de variable dans la fonction `compute_format`, qui écrasait une fonction du noyau python.



## 1.6.0

Expand Down
13 changes: 2 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,13 @@ Nous utilisons les git hooks via [pre-commit](https://pre-commit.com/) pour appl

Voir le fichier de configuration correspondant : `.pre-commit-config.yaml`.

## Changelog
## Pull request

Pour éviter les conflits d'édition du changelog en cas de multiples contributions parallèles, n'éditez pas directement le fichier `CHANGELOG.md` sur votre branche de travail.

A la place, indiquez en description ou commentaire de votre pull request, bien en évidence, le changelog qui concerne spécifiquement cette PR, avec le même formalisme que le fichier `CHANGELOG.md`.

Lors de la release de la prochaine version, le mainteneur ajoutera vos notes de modifications dans le fichier `CHANGELOG.md` ce fichier dans le même temps, avec deux objectifs :

* la date de modification sera celle de la fusion de branches.
* le contenu pourra tenir compte de toutes les modifications depuis la dernière release.
Le titre de la PR est utilisé pour constituer automatiquement les notes de release. Vous pouvez préciser en commentaire de votre PR des détails qui seront ajoutés dans le fichier `CHANGELOG.md` par les mainteneurs du projet.

Le formalisme du changelog est le suivant, en markdown :

```md
Résumé des objectifs des modifications apportées

### [Added]

Liste de nouvelles fonctionnalités.
Expand Down
6 changes: 1 addition & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,6 @@

Ces librairies facilitent la manipulation d'entités du projet ROK4 comme les Tile Matrix Sets, les pyramides ou encore les couches, ainsi que la manipulation des stockages associés.

- [Installer la librairie](#installer-la-librairie)
- [Utiliser la librairie](#utiliser-la-librairie)
- [Compiler la librairie](#compiler-la-librairie)
- [Publier la librairie sur Pypi](#publier-la-librairie-sur-pypi)

## Installer la librairie

Installations système requises :
Expand Down Expand Up @@ -73,6 +68,7 @@ python3 -m build
```

Remarque :

Lors de l'installation du paquet apt `python3-gdal`, une dépendance, peut demander des interactions de configuration. Pour installer dans un environnement non-interactif, définir la variable shell `DEBIAN_FRONTEND=noninteractive` permet d'adopter une configuration par défaut.

## Publier la librairie sur Pypi
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ test = [
[project.urls]
"Homepage" = "https://rok4.github.io/core-python"
"Bug Reports" = "https://github.com/rok4/core-python/issues"
"Changelog" = "https://github.com/rok4/core-python/releases"
"Changelog" = "https://github.com/rok4/core-python/versions/"
"Source" = "https://github.com/rok4/core-python"

[build-system]
Expand Down

0 comments on commit 7bdbc8b

Please sign in to comment.