Merge pull request #244 from PolicyEngine/maria/microdf_housekeeping

Microdf housekeeping

Author: nikhilwoodruff

.github/CONTRIBUTING.md

@@ -0,0 +1,7 @@
+## Updating the code
+
+Please make sure that introduced changes are consistent with the testing api and add additional tests if relevant.
+
+## Updating the versioning
+
+Please add to `changelog.yaml` and then run `make changelog` before committing the results ONCE in this PR.

.github/changelog_template.md

@@ -0,0 +1,6 @@
+Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
+
+{{changelog}}

.github/get-changelog-diff.sh

@@ -0,0 +1,2 @@
+last_tagged_commit=`git describe --tags --abbrev=0 --first-parent`
+git --no-pager diff $last_tagged_commit -- CHANGELOG.md

.github/has-functional-changes.sh

@@ -0,0 +1,12 @@
+#! /usr/bin/env bash
+
+IGNORE_DIFF_ON="README.md CONTRIBUTING.md Makefile docs/* .gitignore LICENSE* .github/* data/*"
+
+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
+  echo "No functional changes detected."
+  exit 1
+else echo "The functional files above were changed."
+fi

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

@@ -0,0 +1,33 @@
+#! /usr/bin/env bash
+
+if [[ ${GITHUB_REF#refs/heads/} == master ]]
+then
+    echo "No need for a version check on master."
+    exit 0
+fi
+
+if ! $(dirname "$BASH_SOURCE")/has-functional-changes.sh
+then
+    echo "No need for a version update."
+    exit 0
+fi
+
+current_version=`python .github/fetch_version.py`
+
+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 master."
+    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

.github/publish-git-tag.sh

@@ -0,0 +1,4 @@
+#! /usr/bin/env bash
+
+git tag `python .github/fetch_version.py`  # create a new tag
+git push --tags || true  # update the repository version

.github/workflows/build_and_test.yml

@@ -0,0 +1,29 @@
+name: Versioning
+
+on:
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  check-changelog-entry:
+    name: Changelog entry check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      
+      - name: Check for changelog entry
+        run: |
+          if [ ! -f "changelog_entry.yaml" ]; then
+            echo "Error: changelog_entry.yaml file is missing."
+            echo "Please add a changelog_entry.yaml file at the root of the repository."
+            exit 1
+          fi
+          
+          # Check if the file is empty
+          if [ ! -s "changelog_entry.yaml" ]; then
+            echo "Error: changelog_entry.yaml file is empty."
+            echo "Please add content to the changelog_entry.yaml file."
+            exit 1
+          fi
+          
+          echo "Changelog entry found and is not empty."