Merge pull request #1042 from redbeard/update-github-pr-workflow-to-currency

Update ARM (Dockerfile) and PR (build on pull request) GitHub workflows to current versions

Author: dkeeney

.dockerignore

@@ -0,0 +1,31 @@
+# Exclude build artifacts - these should be built inside the container
+build/
+dist/
+*.egg-info/
+__pycache__/
+*.pyc
+*.pyo
+*.pyd
+
+# Exclude git metadata
+.git/
+.gitignore
+.gitmodules
+
+# Exclude IDE and editor files
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# Exclude macOS files
+.DS_Store
+
+# Exclude CI/CD files (optional, uncomment if you want to exclude)
+# .github/
+# .circleci/
+
+# Exclude documentation build artifacts
+docs/_build/
+

.github/workflows/arm.yml

@@ -4,30 +4,40 @@ on:
   # run every day of the week at 02:00
   schedule:
     - cron: 0 2 * * *
+  workflow_dispatch:
 
 jobs:
  build-arm64-docker:
   name: Build for ARM64 on Docker
-  runs-on: ubuntu-20.04
-  if: (github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')) || github.event_name == 'schedule' # tag or schedule
+  runs-on: ubuntu-24.04-arm
   steps:
-    - name: Install docker # bug in ubuntu, conflicts with docker.io
+    - name: Check Docker and Docker Compose versions
       run: |
-        sudo apt-get update
-        sudo apt-get remove --purge -y moby-engine moby-cli
-        sudo apt-get install -y qemu-user-static docker.io
-
+        docker --version
+        docker compose version
+        
     - uses: actions/checkout@v2
 
     - name: ARM64 build
       run: |
-        sudo docker build -t htm-arm64-docker --build-arg arch=arm64 .
+        docker build -t htm-arm64-docker --build-arg arch=arm64 .
 
     - name: Tests
       run: |
-        sudo docker run htm-arm64-docker python setup.py test
+        docker run htm-arm64-docker python htm_test.py
+
+    - name: Login to GitHub Container Registry
+      uses: docker/login-action@v3
+      with:
+        registry: ghcr.io
+        username: ${{ github.actor }}
+        password: ${{ secrets.GITHUB_TOKEN }}
 
-    - name: Copy files from docker
+    - name: Tag and push Docker image
       run: |
-        sudo docker cp `sudo docker ps -alq`:/usr/local/src/htm.core/dist dist #TODO the `command` is not 100% reliable, replace with some name/id
-        ls dist
+        docker tag htm-arm64-docker ghcr.io/${{ github.repository }}/htm-arm64:latest
+        docker tag htm-arm64-docker ghcr.io/${{ github.repository }}/htm-arm64:${{ github.run_number }}
+        docker tag htm-arm64-docker ghcr.io/${{ github.repository }}/htm-arm64:${{ github.sha }}
+        docker push ghcr.io/${{ github.repository }}/htm-arm64:latest
+        docker push ghcr.io/${{ github.repository }}/htm-arm64:${{ github.run_number }}
+        docker push ghcr.io/${{ github.repository }}/htm-arm64:${{ github.sha }}

.github/workflows/pr.yml

@@ -5,6 +5,10 @@ on:
   pull_request:
     branches:
     - master
+  # run on push events to the master branch
+  push:
+    branches:
+    - master
   # run every day of the week at 02:00
   schedule:
   - cron: 0 2 * * *
@@ -16,15 +20,15 @@ jobs:
     strategy:
       #max-parallel: 4
       matrix:
-        python-version: [3.9.x]
+        python-version: [3.13.x]
         # https://docs.github.com/en/actions/reference/specifications-for-github-hosted-runners
-        os: [ubuntu-20.04, windows-2019, macos-10.15] #TODO upgrade to macos-11.0 when available on GH Actions CI
+        os: [ubuntu-latest, windows-latest, macos-latest] 
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
 
     - name: Set up Python ${{ matrix.python-version }} for PR
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
 
@@ -56,17 +60,35 @@ jobs:
 
     - name: Install dependencies
       run: |
-        python -m pip install -r requirements.txt
-        python setup.py configure
+        python -m pip install setuptools wheel
+
+    - name: Setup venv and build htmcore (Linux & macOS)
+      if: matrix.os == 'ubuntu-latest' || matrix.os == 'macos-latest'
+      run: |
+        python -m venv .venv
+        source .venv/bin/activate
+        python htm_install.py
+
+    - name: Setup venv and build htmcore (Windows)
+      if: matrix.os == 'windows-latest'
+      run: |
+        python -m venv .venv
+        .venv\Scripts\python.exe htm_install.py
 
-    - name: build htmcore with setup.py
-      run: python setup.py install --user --force
+    - name: C++ & Python Tests (Linux & macOS)
+      if: matrix.os == 'ubuntu-latest' || matrix.os == 'macos-latest'
+      run: |
+        source .venv/bin/activate
+        python htm_test.py
 
-    - name: C++ & Python Tests
-      run: python setup.py test
+    - name: C++ & Python Tests (Windows)
+      if: matrix.os == 'windows-latest'
+      run: |
+        .venv\Scripts\activate.bat
+        .venv\Scripts\python.exe htm_test.py
 
     - name: Memory leaks check (valgrind)
-      if: matrix.os == 'ubuntu-20.04'
+      if: matrix.os == 'ubuntu-latest'
       run: |
         sudo apt-get -y install valgrind
         LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:${PWD}/build/Release/lib valgrind  --show-leak-kinds=definite,indirect,possible,reachable --track-origins=yes --num-callers=40 --error-exitcode=3 ./build/Release/bin/hello 5 || exit 1
@@ -78,36 +100,10 @@ jobs:
       run: ./build/Release/bin/napi_hello 1000 || exit 3
 
     - name: Hello example (dynamically linked)
-      if: matrix.os == 'ubuntu-20.04'
+      if: matrix.os == 'ubuntu-latest'
       run: LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:${PWD}/build/Release/lib ./build/Release/bin/dynamic_hello 1000 || exit 4
 
-    - uses: actions/upload-artifact@v2
+    - uses: actions/upload-artifact@v4
       with:
-        name: "pr_build"
-        path: build/Release/distr/dist
-
-
-
-  build-debug:
-    name: Build and test in Debug mode
-    #currently cannot run on Linux & Debug due to a bug in YAML parser: issue #218
-    runs-on: macOS-latest
-    steps:
-    - uses: actions/checkout@v2
-
-    - name: Install dependencies (Debug)
-      run: |
-        mkdir -p build/scripts
-        cd build/scripts
-        cmake ../.. -DCMAKE_BUILD_TYPE=Debug
-
-    - name: Debug build
-      run: |
-        cd build/scripts
-        make -j2 && make install
-
-    - name: C++ Tests
-      run: |
-        cd build/scripts
-        ../Debug/bin/unit_tests
-
+        name: htm-core-${{ matrix.os }}-py-${{ matrix.python-version }}-${{ github.ref_name }}-${{ github.sha }}
+        path: dist/*.whl

Dockerfile

@@ -16,6 +16,9 @@ ARG host=amd64
 FROM multiarch/qemu-user-static as bootstrap
 ARG arch
 ARG host
+LABEL org.opencontainers.image.description="Docker image with a pre-built, tested and packaged community maintained htm.core library"
+LABEL org.opencontainers.image.source="https://github.com/htm-community/htm.core"
+
 RUN echo "Switching from $host to $arch" && uname -a
 
 ## Stage 1: build of htm.core on the target platform

external/digestpp.cmake

@@ -13,15 +13,15 @@
 # See the GNU Affero Public License for more details.
 #
 # You should have received a copy of the GNU Affero Public License
-# along with this program.  If not, see http://www.gnu.org/licenses.
+# along with this program.� If not, see http://www.gnu.org/licenses.
 # -----------------------------------------------------------------------------
 
 # Download digestpp hash digest package from GitHub archive
 # This file downloads and configures the digestpp library.
 #  header-only, no build.
 include(FetchContent)
 
-set(dependency_url "https://github.com/kerukuro/digestpp/archive/34ff2eeae397ed744d972d86b5a20f603b029fbd.zip")
+set(dependency_url "https://github.com/kerukuro/digestpp/archive/refs/heads/master.zip")
 set(local_override "${CMAKE_SOURCE_DIR}/build/Thirdparty/digestpp")
 
 # Check if local path exists and if so, use it as-is.