Improve quantity and quality of matches

.github/workflows/readme_installation.yml

@@ -0,0 +1,86 @@
+name: readme_installation
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, closed]
+    branches:
+      - main
+
+jobs:
+  readme_installation:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30 # change max time from default 6hr
+
+    steps:
+      #######################
+      # Configure
+      #######################
+
+      - name: Check out code repository (main branch)
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.base_ref }}
+        if: github.event.pull_request.merged == true
+
+      - name: Check out code repository (head branch)
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.head_ref }}
+        if: github.event.pull_request.merged != true
+
+      #######################
+      # Build
+      #######################
+
+      - name: Write installation instructions (main branch)
+        run: |
+          cat > readme_installation_instructions.md <<"EOL"
+          Install **calipmatch** in Stata from the SSC repository:
+          ```
+          ssc install calipmatch
+          ```
+
+          Or you can install **calipmatch** in Stata directly from this Github repository:
+          ```
+          net install calipmatch, from(https://github.com/michaelstepner/calipmatch/raw/main)
+          ```
+          EOL
+        if: github.event.pull_request.merged == true
+
+      - name: Write installation instructions (head branch)
+        run: |
+          cat > readme_installation_instructions.md <<"EOL"
+          This development version of **calipmatch** can be installed using:
+          ```
+          net install calipmatch, from(https://github.com/michaelstepner/calipmatch/raw/${GITHUB_HEAD_REF})
+          ```
+          EOL
+
+          sed -i "s/\${GITHUB_HEAD_REF}/${GITHUB_HEAD_REF}/" readme_installation_instructions.md
+        if: github.event.pull_request.merged != true
+
+      - name: Place installation instructions in README.md
+        run: |
+          sed -z -i 's/<!-- Begin installation instructions -->.*<!-- End installation instructions -->/<!-- Begin installation instructions -->\n\n<!-- End installation instructions -->/' README.md
+          sed -i '/<!-- Begin installation instructions -->/ r readme_installation_instructions.md' README.md
+          rm readme_installation_instructions.md
+
+      #######################
+      # Push
+      #######################
+
+      - name: Check if there are changes
+        run: |
+          set +e
+          test -z "$(git status --porcelain)"
+          echo "README_UPDATED=$?" >> $GITHUB_ENV
+
+      - name: Push updated README to Github
+        run: |
+          git config user.name OppInsights-Bot
+          git config user.email info@opportunityinsights.org
+          git pull --ff-only
+          git add README.md
+          git commit -m "README: update installation instructions"
+          git push
+        if: env.README_UPDATED == 1

.github/workflows/readme_sthlp.yml

@@ -0,0 +1,67 @@
+name: readme_sthlp
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+    paths:
+      - 'calipmatch.sthlp'
+  workflow_dispatch:
+
+jobs:
+  readme_sthlp:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30 # change max time from default 6hr
+
+    steps:
+      #######################
+      # Configure
+      #######################
+
+      - name: Check out code repository (main branch)
+        uses: actions/checkout@v3
+        if: github.ref == 'refs/heads/main'
+
+      - name: Check out code repository (PR branch)
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.pull_request.head.ref }}
+        if: github.ref != 'refs/heads/main'
+
+      - name: Install Stata
+        run: ./automation/install_stata.sh
+        env:
+          OI_HTTPS_PW: ${{ secrets.OI_HTTPS_PW }}
+          STATA_VERSION: 16
+
+      #######################
+      # Build
+      #######################
+
+      - name: Convert Stata help file to HTML
+        run: stata-mp log html calipmatch.sthlp calipmatch.html
+
+      - name: Place Stata help file in README.md
+        run: |
+          sed -z -i 's/<!-- Begin calipmatch.sthlp -->.*<!-- End calipmatch.sthlp -->/<!-- Begin calipmatch.sthlp -->\n\n<!-- End calipmatch.sthlp -->/' README.md
+          sed -i '/<!-- Begin calipmatch.sthlp -->/ r calipmatch.html' README.md
+          rm calipmatch.html
+
+      #######################
+      # Push
+      #######################
+
+      - name: Check if there are changes
+        run: |
+          set +e
+          test -z "$(git status --porcelain)"
+          echo "README_UPDATED=$?" >> $GITHUB_ENV
+
+      - name: Push updated README to Github
+        run: |
+          git config user.name OppInsights-Bot
+          git config user.email info@opportunityinsights.org
+          git pull --ff-only
+          git add README.md
+          git commit -m "README: update embedded calipmatch.sthlp"
+          git push
+        if: env.README_UPDATED == 1

.github/workflows/stata_tests.yml

@@ -1,6 +1,8 @@
 name: stata_tests
 
 on:
+  pull_request:
+    types: [opened, synchronize, reopened]
   workflow_dispatch:
 
 jobs:
@@ -9,5 +11,28 @@ jobs:
     timeout-minutes: 30 # change max time from default 6hr
 
     steps:
-      - name: Hello World
-        run: echo "Hello World"
+      #######################
+      # Configure
+      #######################
+
+      - name: Check out code repository
+        uses: actions/checkout@v3
+
+      - name: Install Stata
+        run: ./automation/install_stata.sh
+        env:
+          OI_HTTPS_PW: ${{ secrets.OI_HTTPS_PW }}
+          STATA_VERSION: 16
+
+      #######################
+      # Build
+      #######################
+
+      - name: Run tests
+        run: |
+          stata-mp -b do test_calipmatch.do
+          cat test_calipmatch.log
+          if egrep --before-context=1 --max-count=1 "^r\([0-9]+\);$" test_calipmatch.log
+          then
+              exit 1
+          fi

.github/workflows/version_increment.yml

@@ -0,0 +1,144 @@
+name: version_increment
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+    branches:
+      - main
+    paths:
+      - 'calipmatch.ado'
+      - 'calipmatch.sthlp'
+      - 'calipmatch.pkg'
+  workflow_dispatch:
+
+jobs:
+  version_increment:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30 # change max time from default 6hr
+
+    steps:
+      #######################
+      # Configure
+      #######################
+
+      - name: Check out repository, PR branch
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.pull_request.head.ref }}
+          path: pr
+
+      - name: Check out repository, main branch
+        uses: actions/checkout@v3
+        with:
+          ref: main
+          path: main
+
+      - name: Obtain 'version number' and 'changed date' from ado-file and help-file
+        run: |
+          for b in "pr" "main"; do
+            cd ${b}
+            echo "${b}_ado_version=$(head -n 1 calipmatch.ado | sed -nE 's/.*version ([0-9]+\.[0-9]+\.[0-9]+).*/\1/p')" >> $GITHUB_ENV
+            echo "${b}_ado_date=$(head -n 1 calipmatch.ado | sed -nE 's/.*version [0-9]+\.[0-9]+\.[0-9]+ +([0-3]?[0-9][a-z][a-z][a-z][0-9][0-9][0-9][0-9]).*/\1/p')" >> $GITHUB_ENV
+
+            echo "${b}_help_version=$(sed '2q;d' calipmatch.sthlp | sed -nE 's/.*version ([0-9]+\.[0-9]+\.[0-9]+).*/\1/p')" >> $GITHUB_ENV
+            echo "${b}_help_date=$(sed '2q;d' calipmatch.sthlp | sed -nE 's/.*version [0-9]+\.[0-9]+\.[0-9]+ +([0-3]?[0-9][a-z][a-z][a-z][0-9][0-9][0-9][0-9]).*/\1/p')" >> $GITHUB_ENV
+            cd ..
+          done
+
+      #######################
+      # Version numbers
+      #######################
+
+      - name: Validate ado-file version numbers exist
+        run: |
+          if [[ -z ${pr_ado_version} ]]; then
+            echo "PR branch: version number not detected in calipmatch.ado"
+            exit 1
+          fi
+          if [[ -z ${main_ado_version} ]]; then
+            echo "main branch: version number not detected in calipmatch.ado"
+            exit 1
+          fi
+
+      - name: Validate help-file version numbers exist
+        run: |
+          if [[ -z ${pr_help_version} ]]; then
+            echo "PR branch: version number not detected in calipmatch.sthlp"
+            exit 1
+          fi
+          if [[ -z ${main_help_version} ]]; then
+            echo "main branch: version number not detected in calipmatch.sthlp"
+            exit 1
+          fi
+
+      - name: Validate ado-file version numbers are incremented
+        run: |
+          for b in "pr" "main"; do
+            v=${b}_ado_version
+            printf -v "${b}_major" "%s" "$(echo "${!v}" | sed -nE 's/([0-9]+)\.[0-9]+\.[0-9]+/\1/p')"
+            printf -v "${b}_minor" "%s" "$(echo "${!v}" | sed -nE 's/[0-9]+\.([0-9]+)\.[0-9]+/\1/p')"
+            printf -v "${b}_patch" "%s" "$(echo "${!v}" | sed -nE 's/[0-9]+\.[0-9]+\.([0-9]+)/\1/p')"
+          done
+          if [[ ! $pr_major -gt $main_major ]] && [[ ! $pr_minor -gt $main_minor ]] && [[ ! $pr_minor -gt $main_minor ]]; then
+            echo "version number not incremented, pr=${pr_ado_version} main=${main_ado_version}"
+            exit 1
+          fi
+
+      - name: Validate help-file version numbers match ado-file version numbers
+        run: |
+          if [[ "$pr_ado_version" != "$pr_help_version" ]]; then
+            echo "version numbers in calipmatch.ado and calipmatch.sthlp do not match, ado=${pr_ado_version} sthlp=${pr_help_version}"
+            exit 1
+          fi
+          if [[ "$main_ado_version" != "$main_help_version" ]]; then
+            echo 'error in main branch:'
+            echo "version numbers in calipmatch.ado and calipmatch.sthlp do not match, ado=${main_ado_version} sthlp=${main_help_version}"
+            exit 1
+          fi
+
+      #######################
+      # Date last updated
+      #######################
+
+      - name: Update date in ado-file and help-file
+        run: |
+          today=$(TZ=America/New_York date +%-d%b%Y | tr A-Z a-z)
+          if [[ "$pr_ado_date" != "$today" ]]; then
+            sed -i "1s/${pr_ado_date}/${today}/" calipmatch.ado
+          fi
+          if [[ "$pr_help_date" != "$today" ]]; then
+            sed -i "2s/${pr_help_date}/${today}/" calipmatch.sthlp
+          fi
+        working-directory: pr
+
+      - name: Update date in package-file
+        run: |
+          if grep -q '^d Distribution-Date: [0-9][0-9][0-9][0-9][0-1][0-9][0-3][0-9]' calipmatch.pkg; then
+            sed -i "s/^d Distribution-Date: [0-9][0-9][0-9][0-9][0-1][0-9][0-3][0-9]/d Distribution-Date: $(TZ=America/New_York date +%Y%m%d)/" calipmatch.pkg
+          else
+            echo "PR branch: Distribution-Date not detected in calipmatch.pkg"
+            exit 1
+          fi
+        working-directory: pr
+
+      #######################
+      # Push
+      #######################
+
+      - name: Check if there are changes
+        run: |
+          set +e
+          test -z "$(git status --porcelain)"
+          echo "FILES_UPDATED=$?" >> $GITHUB_ENV
+        working-directory: pr
+
+      - name: Push updates to Github
+        run: |
+          git config user.name OppInsights-Bot
+          git config user.email info@opportunityinsights.org
+          git pull --ff-only
+          git add calipmatch.ado calipmatch.sthlp calipmatch.pkg
+          git commit -m "Update 'last updated' dates"
+          git push
+        if: env.FILES_UPDATED == 1
+        working-directory: pr