Skip to content

Commit

Permalink
Ajoute un fichier CHANGELOG.md (#175)
Browse files Browse the repository at this point in the history
- Format Common Changelog
- Ajoute une étape de vérification dans la CI
  • Loading branch information
Allan-CodeWorks authored Aug 16, 2023
1 parent 7a00fea commit 69e7a50
Show file tree
Hide file tree
Showing 5 changed files with 42 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .github/has-functional-changes.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#! /usr/bin/env bash

IGNORE_DIFF_ON="README.md CONTRIBUTING.md Makefile .gitignore .github/*"
IGNORE_DIFF_ON="README.md CHANGELOG.md CONTRIBUTING.md Makefile .gitignore .github/*"

last_tagged_commit=`git describe --tags --abbrev=0 --first-parent` # --first-parent ensures we don't follow tags not published in master through an unlikely intermediary merge commit

Expand Down
8 changes: 8 additions & 0 deletions .github/is-version-number-acceptable.sh
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,11 @@ then
echo "Look at the CONTRIBUTING.md file to learn how the version number should be updated."
exit 1
fi

if ! $(dirname "$BASH_SOURCE")/has-functional-changes.sh | grep --quiet CHANGELOG.md
then
echo "CHANGELOG.md has not been modified, while functional changes were made."
echo "Explain what you changed before merging this branch into master."
echo "Look at the CONTRIBUTING.md file to learn how to write the changelog."
exit 2
fi
4 changes: 2 additions & 2 deletions .github/workflows/workflow.yml
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ jobs:
run: |
openfisca test tests --country-package openfisca_france --extensions openfisca_france_local
check-version:
check-version-and-changelog:
runs-on: ubuntu-20.04
needs: [ test-yaml ] # Last job to run
steps:
Expand All @@ -86,7 +86,7 @@ jobs:
check-for-functional-changes:
runs-on: ubuntu-20.04
if: github.ref == 'refs/heads/master' # Only triggered for the `master` branch
needs: [ check-version ]
needs: [ check-version-and-changelog ]
outputs:
status: ${{ steps.stop-early.outputs.status }}
steps:
Expand Down
22 changes: 22 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Changelog

## [6.0.1] - 2023-07-31

_Pour les changements détaillés et les discussions associées, consultez la pull request [#174](https://github.com/openfisca/openfisca-france-local/pull/174)_

### Changed

- Modifie l'implantation du paramètre taux_incapacité dans la réforme dynamique Aides-Jeunes, sans changement des résultats des calculs

## [6.0.0] - 2023-07-24

_Pour les changements détaillés et les discussions associées, consultez la pull request [#173](https://github.com/openfisca/openfisca-france-local/pull/173)_

### Added

- Ajoute la compatibilité avec `OpenFisca-Core` v41.x
- Ajoute la compatibilité avec `OpenFisca-France` v150.x

### Removed

- **Breaking:** retire la génération de documentation dans l'API Web à la suite de la mise à jour d'`openfisca-Core v41` ([OpenFisca-Core #1189](https://github.com/openfisca/openfisca-core/pull/1189))
10 changes: 9 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,14 @@ Certaines règles sont communes à tous les dépôts OpenFisca et sont détaill

## Gestion sémantique de version

Le niveau des évolutions d'OpenFisca-France-Local doivent pouvoir être comprises par des réutilisateurs qui n'interviennent pas nécessairement sur le code.
Le niveau des évolutions d'OpenFisca-France-Local doivent pouvoir être comprises par des réutilisateurs qui n'interviennent pas nécessairement sur le code.

Un numéro de version doit donc être attribué à toute évolution intégrée sur la branche principale `master` (par la mise à jour du fichier `setup.py`). Ses règles d'incrémentation suivent les principes du versionnement sémantique détaillés dans [la documentation générale](https://openfisca.org/doc/contribute/semver.html).

## Formalisation du CHANGELOG

Chaque version donne lieu à une description des changements qu'elle apporte dans le fichier `CHANGELOG.md`, fichier qui respecte le standard [Common Changelog](https://common-changelog.org).

La syntaxe à utiliser pour une entrée valide est détaillée dans [le wiki](https://github.com/openfisca/openfisca-france-local/wiki/Ajouter-une-entr%C3%A9e-dans-le-CHANGELOG).

Chaque Pull Request acceptée sur la branche principale déclenche le déploiement d'une nouvelle version.

0 comments on commit 69e7a50

Please sign in to comment.