Switch from CircleCI to GitHub Actions

Merge pull request #115 from openfisca/github-actions

.circleci/has-functional-changes.sh → .github/has-functional-changes.sh

@@ -1,8 +1,8 @@
 #! /usr/bin/env bash
 
-IGNORE_DIFF_ON="README.md CONTRIBUTING.md Makefile .gitignore .circleci/* .github/*"
+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 master 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 master 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

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

@@ -1,6 +1,6 @@
 #! /usr/bin/env bash
 
-if [[ $CIRCLE_BRANCH == master ]]
+if [[ ${GITHUB_REF#refs/heads/} == master ]]
 then
     echo "No need for a version check on master."
     exit 0
@@ -12,7 +12,7 @@ then
     exit 0
 fi
 
-current_version=`python setup.py --version`
+current_version=$(python setup.py --version)
 
 if git rev-parse --verify --quiet $current_version
 then

.github/lint-changed-python-files.sh

@@ -0,0 +1,11 @@
+#! /usr/bin/env bash
+
+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
+
+if ! changes=$(git diff-index --name-only --diff-filter=ACMR --exit-code $last_tagged_commit -- "*.py")
+then
+  echo "Linting the following Python files:"
+  echo $changes
+  flake8 $changes
+else echo "No changed Python files to lint"
+fi

.github/lint-changed-yaml-tests.sh

@@ -0,0 +1,11 @@
+#! /usr/bin/env bash
+
+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
+
+if ! changes=$(git diff-index --name-only --diff-filter=ACMR --exit-code $last_tagged_commit -- "tests/*.yaml")
+then
+  echo "Linting the following changed YAML tests:"
+  echo $changes
+  yamllint $changes
+else echo "No changed YAML tests to lint"
+fi

.circleci/publish-git-tag.sh → .github/publish-git-tag.sh

@@ -1,4 +1,4 @@
 #! /usr/bin/env bash
 
-git tag `python setup.py --version`
+git tag $(python setup.py --version)
 git push --tags  # update the repository version

.github/workflows/workflow.yml

@@ -0,0 +1,156 @@
+name: Country-Template
+
+on: [ push ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.7.12 # Patch version must be specified to avoid any cache confusion, since the cache key depends on the full Python version. Any potentiel difference in patches between jobs will lead to a cache not found error.
+      - name: Cache build
+        id: restore-build
+        uses: actions/cache@v2
+        with:
+          path: ${{ env.pythonLocation }}
+          key: build-${{ env.pythonLocation }}-${{ hashFiles('setup.py') }}-${{ github.sha }} # Cache the entire build Python environment
+          restore-keys: |
+            build-${{ env.pythonLocation }}-${{ hashFiles('setup.py') }}
+            build-${{ env.pythonLocation }}-
+      - name: Build package
+        run: make build
+      - name: Cache release
+        id: restore-release
+        uses: actions/cache@v2
+        with:
+          path: dist
+          key: release-${{ env.pythonLocation }}-${{ hashFiles('setup.py') }}-${{ github.sha }}
+
+  lint-files:
+    runs-on: ubuntu-latest
+    needs: [ build ]
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0 # Fetch all the tags
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.7.12
+      - name: Cache build
+        id: restore-build
+        uses: actions/cache@v2
+        with:
+          path: ${{ env.pythonLocation }}
+          key: build-${{ env.pythonLocation }}-${{ hashFiles('setup.py') }}-${{ github.sha }}
+      - run: make check-syntax-errors
+      - run: make check-style
+      - name: Lint Python files
+        run: "${GITHUB_WORKSPACE}/.github/lint-changed-python-files.sh"
+      - name: Lint YAML tests
+        run: "${GITHUB_WORKSPACE}/.github/lint-changed-yaml-tests.sh"
+
+  test-yaml:
+    runs-on: ubuntu-latest
+    needs: [ build ]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.7.12
+      - name: Cache build
+        id: restore-build
+        uses: actions/cache@v2
+        with:
+          path: ${{ env.pythonLocation }}
+          key: build-${{ env.pythonLocation }}-${{ hashFiles('setup.py') }}-${{ github.sha }}
+      - run: openfisca test --country-package openfisca_country_template openfisca_country_template/tests
+
+  test-api:
+    runs-on: ubuntu-latest
+    needs: [ build ]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.7.12
+      - name: Cache build
+        id: restore-build
+        uses: actions/cache@v2
+        with:
+          path: ${{ env.pythonLocation }}
+          key: build-${{ env.pythonLocation }}-${{ hashFiles('setup.py') }}-${{ github.sha }}
+      - name: Test the Web API
+        run: "${GITHUB_WORKSPACE}/.github/test-api.sh"
+
+  check-version-and-changelog:
+    runs-on: ubuntu-latest
+    needs: [ lint-files, test-yaml, test-api ] # Last job to run
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0 # Fetch all the tags
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.7.12
+      - name: Check version number has been properly updated
+        run: "${GITHUB_WORKSPACE}/.github/is-version-number-acceptable.sh"
+
+  # GitHub Actions does not have a halt job option, to stop from deploying if no functional changes were found.
+  # We build a separate job to substitute the halt option.
+  # The `deploy` job is dependent on the output of the `check-for-functional-changes`job.
+  check-for-functional-changes:
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/master' # Only triggered for the `master` branch
+    needs: [ check-version-and-changelog ]
+    outputs:
+      status: ${{ steps.stop-early.outputs.status }}
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0 # Fetch all the tags
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.7.12
+      - id: stop-early
+        run: if "${GITHUB_WORKSPACE}/.github/has-functional-changes.sh" ; then echo "::set-output name=status::success" ; fi
+
+  deploy:
+    runs-on: ubuntu-latest
+    needs: [ check-for-functional-changes ]
+    if: needs.check-for-functional-changes.outputs.status == 'success'
+    env:
+      PYPI_USERNAME: openfisca-bot
+      PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0 # Fetch all the tags
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.7.12
+      - name: Cache build
+        id: restore-build
+        uses: actions/cache@v2
+        with:
+          path: ${{ env.pythonLocation }}
+          key: build-${{ env.pythonLocation }}-${{ hashFiles('setup.py') }}-${{ github.sha }}
+      - name: Cache release
+        id: restore-release
+        uses: actions/cache@v2
+        with:
+          path: dist
+          key: release-${{ env.pythonLocation }}-${{ hashFiles('setup.py') }}-${{ github.sha }}
+      - name: Upload a Python package to PyPi
+        run: twine upload dist/* --username $PYPI_USERNAME --password $PYPI_PASSWORD
+      - name: Publish a git tag
+        run: "${GITHUB_WORKSPACE}/.github/publish-git-tag.sh"

CHANGELOG.md

@@ -1,6 +1,12 @@
 # Changelog
 
-### 3.12.10 - [#115](https://github.com/openfisca/country-template/pull/115)
+## 3.13.0 - [#115](https://github.com/openfisca/country-template/pull/115)
+
+* Technical improvement.
+* Details:
+  - Switch continuous integration pipeline from CircleCI to GitHub Actions 
+
+### 3.12.10 - [#119](https://github.com/openfisca/country-template/pull/119)
 
 * Technical improvement.
 * Details:

bootstrap.sh

@@ -36,8 +36,9 @@ all_module_files=`find openfisca_country_template -type f`
 set -x
 
 # Use intermediate backup files (`-i`) with a weird syntax due to lack of portable 'no backup' option. See https://stackoverflow.com/q/5694228/594053.
-sed -i.template "s|country_template|$lowercase_country_name|g" README.md setup.py .circleci/config.yml Makefile MANIFEST.in $all_module_files
-sed -i.template "s|Country-Template|$COUNTRY_NAME|g" README.md setup.py .github/PULL_REQUEST_TEMPLATE.md CONTRIBUTING.md $all_module_files
+# If you're using MacOS, add LC_ALL=C before sed https://stackoverflow.com/questions/19242275/re-error-illegal-byte-sequence-on-mac-os-x/19770395#19770395
+sed -i.template "s|country_template|$lowercase_country_name|g" README.md setup.py .github/workflows/workflow.yml Makefile MANIFEST.in $all_module_files
+sed -i.template "s|Country-Template|$COUNTRY_NAME|g" README.md setup.py .github/workflows/workflow.yml .github/PULL_REQUEST_TEMPLATE.md CONTRIBUTING.md $all_module_files
 sed -i.template -e "3,${last_bootstrapping_line_number}d" README.md  # remove instructions lines
 sed -i.template "s|country-template|$lowercase_country_name|g" README.md
 sed -i.template "s|https://github.com/openfisca/openfisca-country-template|$URL|g" setup.py

setup.py

@@ -4,7 +4,7 @@
 
 setup(
     name = "OpenFisca-Country-Template",
-    version = "3.12.10",
+    version = "3.13.0",
     author = "OpenFisca Team",
     author_email = "contact@openfisca.org",
     classifiers = [