Publish to conda

.conda/README.md

@@ -0,0 +1,55 @@
+# Publish to conda
+
+There are two ways to publish to conda:
+
+- A fully automatic in CI that publish to an "openfisca" channel. See below for more information.
+- A more complex for Conda-Forge.
+
+We use both for openfisca-core but only _openfisca channel_ for _country-template_.
+
+## Automatic upload
+
+The CI automaticaly upload the PyPi package, see the `.github/workflow.yml`, step `publish-to-conda`.
+
+## Test with Docker
+
+Docker could be used to test the build and the installation of the package.
+
+To test the build:
+
+```sh
+docker run --volume $PWD:/openfisca -i -t continuumio/anaconda3 /bin/bash
+cd /openfisca
+# Check meta.yaml
+conda-build --check .conda
+# Build
+conda install conda-verify
+conda config --add channels defaults
+conda build -c openfisca -c conda-forge .conda
+```
+
+To test the installation of the published package:
+
+```sh
+docker run --volume $PWD:/openfisca -i -t continuumio/anaconda3 /bin/bash
+cd /openfisca
+conda install -c openfisca -c conda-forge openfisca-country-template
+openfisca test --country-package openfisca-country-template tests
+```
+
+To do the publication of the package, normaly not needed as it is done by the CI! :
+
+```sh
+docker run --volume $PWD:/openfisca -i -t continuumio/anaconda3 /bin/bash
+cd /openfisca
+# Build
+conda build -c openfisca -c conda-forge .conda
+anaconda login
+anaconda upload openfisca-country-template-<VERSION>-py_0.tar.bz2
+```
+
+## Manual actions made to make it works the first time
+
+- Create an account on https://anaconda.org.
+- Create a token on https://anaconda.org/openfisca/settings/access with _Allow write access to the API site_. Warning, it expire on 2023/01/13.
+- Put the token in a CI env variable ANACONDA_TOKEN.

.conda/meta.yaml

@@ -0,0 +1,53 @@
+###############################################################################
+## Package description for Anaconda.org
+## Warning : string PYPI_VERSION, PYPI_URL and PYPI_SHA256 are replaced by CI
+## Keep them as is.
+###############################################################################
+
+{% set name = "OpenFisca-Country-Template" %}
+{% set pyproject = load_file_data('pyproject.toml') %}
+{% set version = pyproject.get('project').get('version') %}
+
+package:
+  name: {{ name|lower }}
+  version: {{ version }}
+
+source:
+  path: ..
+
+build:
+  noarch: python
+  number: 0
+  script: "{{ PYTHON }} -m pip install . -vv"
+
+requirements:
+  host:
+    - python
+    - pip
+  run:
+    {% for req in pyproject.get('project').get('dependencies') %}
+    - {{ req | replace(" ", "") }}
+    {% endfor %}
+
+test:
+  imports:
+    - openfisca_country_template
+  requires:
+    - pip
+  commands:
+    - pip check
+
+outputs:
+  - name: openfisca-country-template
+
+about:
+  home: https://fr.openfisca.org/
+  license_family: AGPL
+  license: AGPL-3.0-only
+  license_file: LICENSE
+  summary: "OpenFisca tax and benefit system for Country-Template."
+  description: |
+    OpenFisca is a versatile microsimulation free software.
+    This repository contains the Country-Template module, to work with OpenFisca.
+  doc_url: https://fr.openfisca.org/
+  dev_url: https://github.com/openfisca/country-template/

.github/has-functional-changes.sh

@@ -2,7 +2,7 @@
 
 IGNORE_DIFF_ON="README.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 main through an unlikely intermediary merge commit
+last_tagged_commit=`git describe --tags --abbrev=0 --first-parent`  # --first-parent ensures we don't follow tags not published in main through an unlikely intermediary merge commit
 
 if git diff-index --name-only --exit-code $last_tagged_commit -- . `echo " $IGNORE_DIFF_ON" | sed 's/ / :(exclude)/g'`  # Check if any file that has not be listed in IGNORE_DIFF_ON has changed since the last tag was published.
 then

.github/is-version-number-acceptable.sh

@@ -12,16 +12,22 @@ then
     exit 0
 fi
 
-current_version=$(python setup.py --version)
+current_version=$(grep '^version =' pyproject.toml | cut -d '"' -f 2)  # parsing with tomllib is complicated, see https://github.com/python-poetry/poetry/issues/273
+
+if [[ ! $current_version ]]
+then
+    echo "Error getting current version"
+    exit 1
+fi
 
 if git rev-parse --verify --quiet $current_version
 then
     echo "Version $current_version already exists in commit:"
     git --no-pager log -1 $current_version
     echo
-    echo "Update the version number in setup.py before merging this branch into main."
+    echo "Update the version number in pyproject.toml before merging this branch into main."
     echo "Look at the CONTRIBUTING.md file to learn how the version number should be updated."
-    exit 1
+    exit 2
 fi
 
 if ! $(dirname "$BASH_SOURCE")/has-functional-changes.sh | grep --quiet CHANGELOG.md

.github/publish-git-tag.sh

@@ -1,4 +1,5 @@
 #! /usr/bin/env bash
 
-git tag $(python setup.py --version)
+current_version=$(grep '^version =' pyproject.toml | cut -d '"' -f 2)  # parsing with tomllib is complicated, see https://github.com/python-poetry/poetry/issues/273
+git tag $current_version
 git push --tags  # update the repository version

.github/workflows/build.yml

@@ -0,0 +1,34 @@
+name: Build
+
+on:
+  workflow_call:
+
+jobs:
+  build-and-cache:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.9.12 # Patch version must be specified to avoid any cache confusion, since the cache key depends on the full Python version. Any difference in patches between jobs will lead to a cache not found error.
+
+      - name: Cache build
+        uses: actions/cache@v4
+        with:
+          path: ${{ env.pythonLocation }}
+          key: build-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml') }}-${{ github.sha }} # Cache the entire build Python environment
+          restore-keys: |
+            build-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml') }}
+            build-${{ env.pythonLocation }}-
+
+      - name: Build package
+        run: make build
+
+      - name: Cache release
+        uses: actions/cache@v4
+        with:
+          path: dist
+          key: release-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml') }}-${{ github.sha }}

.github/workflows/deploy.yml

@@ -0,0 +1,113 @@
+name: Deploy
+
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  validate:
+    uses: "./.github/workflows/validate.yml"
+
+  # GitHub Actions does not have a halt job option to stop from deploying if no functional changes were found.
+  # We thus execute a separate deployment job depending on the output of this job.
+  check-for-functional-changes:
+    runs-on: ubuntu-22.04
+    outputs:
+      status: ${{ steps.stop-early.outputs.status }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Fetch all the tags
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.9.12
+      - id: stop-early
+        run: |
+          if "${GITHUB_WORKSPACE}/.github/has-functional-changes.sh"
+          then 
+            echo "status=success" >> $GITHUB_OUTPUT
+          fi
+
+  check-pypi-token: # Use intermediary job as secrets cannot be directly referenced in `if:` conditionals; see https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions#using-secrets-in-a-workflow
+    runs-on: ubuntu-22.04
+    outputs:
+      pypi_token_present: ${{ steps.check_token.outputs.pypi_token_present }}
+    steps:
+      - name: Check PyPI token is defined
+        id: check_token
+        run: |
+          if [[ -n "${{ secrets.PYPI_TOKEN }}" ]]
+          then
+            echo "pypi_token_present=true" >> $GITHUB_OUTPUT
+          else
+            echo "pypi_token_present=false" >> $GITHUB_OUTPUT
+          fi
+
+  deploy:
+    runs-on: ubuntu-22.04
+    needs: [ validate, check-for-functional-changes, check-pypi-token ]
+    if: needs.check-for-functional-changes.outputs.status == 'success' && needs.check-pypi-token.outputs.pypi_token_present == 'true'
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.9.12
+      - name: Restore build
+        uses: actions/cache@v4
+        with:
+          path: ${{ env.pythonLocation }}
+          key: build-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml') }}-${{ github.sha }}
+      - name: Restore built package
+        uses: actions/cache@v4
+        with:
+          path: dist
+          key: release-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml') }}-${{ github.sha }}
+      - name: Upload a Python package to PyPi
+        run: twine upload dist/* --username __token__ --password ${{ secrets.PYPI_TOKEN }}
+      - name: Publish a git tag
+        run: "${GITHUB_WORKSPACE}/.github/publish-git-tag.sh"
+
+  publish-to-conda:
+    runs-on: "ubuntu-latest"
+    needs: [ deploy ]
+    strategy:
+      fail-fast: false
+    steps:
+      - uses: conda-incubator/setup-miniconda@v3
+        with:
+          auto-update-conda: true
+          python-version: "3.7.9"
+          # Add conda-forge for OpenFisca-Core
+          channels: conda-forge
+          activate-environment: true
+      - uses: actions/checkout@v4
+      - name: Update meta.yaml
+        run: |
+          python3 -m pip install requests argparse
+          python3 .github/get_pypi_info.py -p OpenFisca-Country-Template
+      - name: Conda Config
+        run: |
+          conda install conda-build anaconda-client
+          conda info
+          conda config --set anaconda_upload yes
+      - name: Conda build
+        run: conda build --token ${{ secrets.ANACONDA_TOKEN }} --user openfisca .conda
+
+  install-on-windows:
+    runs-on: "windows-latest"
+    needs: [ publish-to-conda ]
+    strategy:
+      fail-fast: false
+    steps:
+      - uses: conda-incubator/setup-miniconda@v3
+        with:
+          auto-update-conda: true
+          python-version: "3.9.9"
+          # Add conda-forge for OpenFisca-Core
+          channels: conda-forge
+          activate-environment: true
+      - uses: actions/checkout@v4
+      - name: Install with conda
+        run: conda install -c openfisca openfisca-country-template

.github/workflows/first-time-setup.yml

@@ -0,0 +1,36 @@
+name: First time setup
+
+on:
+  create:
+  workflow_dispatch:
+
+permissions: 
+  actions: write
+  checks: write
+  contents: write
+
+jobs:
+  first-time-setup:
+    # Ensure this job does not run on the template repository or when the repository is forked
+    if: ${{ !github.event.repository.is_template && !github.event.repository.fork }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Infer jurisdiction name from repository name
+        run: |
+          echo "TITLE_CASE_JURISDICTION_NAME=$(echo ${{ github.event.repository.name }} | sed 's/openfisca-//' | sed 's/[-|_]/ /g' | awk '{for (i=1; i<=NF; i++) $i=toupper(substr($i,1,1)) substr($i,2)} 1')" >> $GITHUB_ENV
+
+      - name: Execute the first-time-setup script
+        run: CI=true JURISDICTION_NAME="$TITLE_CASE_JURISDICTION_NAME" REPOSITORY_URL="${{ github.repositoryUrl }}" ./first-time-setup.sh
+
+      - name: Commit changes
+        uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_message: "Customise country-template through CI"
+          tagging_message: "0.0.1"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}