FIX: fixes on pyproject, requirements, workflows, environment

Author: miguelcarcamov

.github/workflows/build.yaml

@@ -9,6 +9,7 @@ on:
 
 env:
   REGISTRY: ghcr.io
+  PYTHON_VERSION: '3.10'
 
 permissions:
   contents: read
@@ -17,10 +18,20 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4.2.0
-    - uses: ptxmac/yapf-action@master
+    - uses: actions/checkout@v4
       with:
-        args: --recursive --verbose
+        fetch-depth: 0
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ env.PYTHON_VERSION }}
+    - name: Install yapf
+      run: |
+        python -m pip install --upgrade pip
+        pip install yapf
+    - name: Run yapf
+      run: |
+        yapf --recursive --verbose --diff .
 
   build:
     runs-on: ubuntu-latest
@@ -31,7 +42,7 @@ jobs:
         username: ${{ github.repository_owner }}
         password: ${{ secrets.REGISTRY_TOKEN }}
     steps:
-    - uses: actions/checkout@v4.2.0
+    - uses: actions/checkout@v4
       with:
         fetch-depth: 0
         set-safe-directory: true
@@ -41,7 +52,6 @@ jobs:
     - name: Install dependencies
       run: |
         python3 -m pip install --upgrade pip wheel setuptools setuptools-scm
-        python3 -m pip install virtualenv
         python3 -m pip install build
     - name: Build package
       run: python3 -m build
@@ -65,7 +75,7 @@ jobs:
         username: ${{ github.repository_owner }}
         password: ${{ secrets.REGISTRY_TOKEN }}
     steps:
-    - uses: actions/checkout@v4.2.0
+    - uses: actions/checkout@v4
       with:
         fetch-depth: 0
         set-safe-directory: true
@@ -77,15 +87,14 @@ jobs:
     #    pip3 install pytest
     #    pip3 install pytest-cov
     - uses: actions/download-artifact@v4
-      id: download
       with:
         name: snow-artifacts
         path: dist/
     - name: Install snow from artifacts
       run: pip3 install dist/*.tar.gz
     #- name: Test with pytest and pycov
-    #  run: pytest --cov=csromer --cov-report xml:coverage.xml --cov-report term-missing tests/ -W "ignore" -v
-    #- uses: codecov/codecov-action@v2
+    #  run: pytest --cov=snow --cov-report xml:coverage.xml --cov-report term-missing tests/ -W "ignore" -v
+    #- uses: codecov/codecov-action@v4
     #  with:
     #    token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
     #    files: ./coverage.xml

.github/workflows/build_base_container.yaml

@@ -6,31 +6,42 @@ on:
     - feature/refactoring
     - development
     paths:
-    - .github/build_base_container.yaml
+    - .github/workflows/build_base_container.yaml
     - Dockerfile
   pull_request:
     branches:
     - master
+    paths:
+    - .github/workflows/build_base_container.yaml
+    - Dockerfile
 
 env:
   REGISTRY: ghcr.io
 
+permissions:
+  contents: read
+  packages: write
+
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout Code
-      uses: actions/checkout@v4.2.0
+      uses: actions/checkout@v4
     - name: Login to GitHub Container Registry
-      uses: docker/login-action@v1
+      uses: docker/login-action@v3
       with:
         registry: ${{ env.REGISTRY }}
         username: ${{ github.repository_owner }}
         password: ${{ secrets.REGISTRY_TOKEN }}
     - name: Setup Docker Buildx
-      uses: docker/setup-buildx-action@v2
+      uses: docker/setup-buildx-action@v3
     - name: Build and Push Docker Image
-      uses: docker/build-push-action@v2
+      uses: docker/build-push-action@v5
       with:
-        push: true   # Will only build if this is not here
+        context: .
+        file: ./Dockerfile
+        push: true
         tags: ${{ env.REGISTRY }}/${{ github.repository }}:base
+        cache-from: type=gha
+        cache-to: type=gha,mode=max

.github/workflows/build_latest_container.yaml

@@ -5,28 +5,41 @@ on:
     branches: [master]
     paths:
     - '**.py'
-    - .github/build_latest_container.yaml
+    - .github/workflows/build_latest_container.yaml
     - Dockerfile.prod
   release:
     types: [published]
 
 env:
   REGISTRY: ghcr.io
+  PYTHON_VERSION: '3.10'
+
+permissions:
+  contents: read
+  packages: write
 
 jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4.2.0
+    - uses: actions/checkout@v4
       with:
         fetch-depth: 0
         set-safe-directory: true
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ env.PYTHON_VERSION }}
     - name: Check git version and our path
       run: |
         git config --global --add safe.directory "$GITHUB_WORKSPACE"
-    - uses: ptxmac/yapf-action@master
-      with:
-        args: --recursive --verbose
+    - name: Install yapf
+      run: |
+        python -m pip install --upgrade pip
+        pip install yapf
+    - name: Run yapf
+      run: |
+        yapf --recursive --verbose --diff .
   build:
     runs-on: ubuntu-latest
     needs: lint
@@ -36,7 +49,7 @@ jobs:
         username: ${{ github.repository_owner }}
         password: ${{ secrets.REGISTRY_TOKEN }}
     steps:
-    - uses: actions/checkout@v4.2.0
+    - uses: actions/checkout@v4
       with:
         fetch-depth: 0
         set-safe-directory: true
@@ -46,15 +59,15 @@ jobs:
     - name: Install dependencies
       run: |
         python3 -m pip install --upgrade pip wheel setuptools setuptools-scm
-        python3 -m pip install virtualenv
         python3 -m pip install build
     - name: Build package
       run: python3 -m build
     - name: Install snow
       run: pip install dist/*.tar.gz
     - name: Upload artifacts
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
+        name: snow-artifacts
         path: dist/*
     - name: Run commands to test that everything is finished
       run: |
@@ -65,18 +78,21 @@ jobs:
     needs: build
     steps:
     - name: Checkout Code
-      uses: actions/checkout@v1
+      uses: actions/checkout@v4
     - name: Login to GitHub Container Registry
-      uses: docker/login-action@v1
+      uses: docker/login-action@v3
       with:
         registry: ${{ env.REGISTRY }}
         username: ${{ github.repository_owner }}
         password: ${{ secrets.REGISTRY_TOKEN }}
     - name: Setup Docker Buildx
-      uses: docker/setup-buildx-action@v2
+      uses: docker/setup-buildx-action@v3
     - name: Build and Push Docker Image
-      uses: docker/build-push-action@v2
+      uses: docker/build-push-action@v5
       with:
+        context: .
         file: ./Dockerfile.prod
-        push: true   # Will only build if this is not here
+        push: true
         tags: ${{ env.REGISTRY }}/${{ github.repository }}:latest
+        cache-from: type=gha
+        cache-to: type=gha,mode=max

.github/workflows/publishpypi.yaml

@@ -12,6 +12,9 @@ on:
 permissions:
   contents: read
 
+env:
+  PYTHON_VERSION: '3.10'
+
 jobs:
   deploy:
     runs-on: ubuntu-latest
@@ -21,30 +24,23 @@ jobs:
         username: ${{ github.repository_owner }}
         password: ${{ secrets.REGISTRY_TOKEN }}
     steps:
-    - uses: actions/checkout@v4.2.0
+    - uses: actions/checkout@v4
       with:
         fetch-depth: 0
         set-safe-directory: true
     - name: Force directory safe
       run: |
         git config --global --add safe.directory "$GITHUB_WORKSPACE"
-    - name: Set up Python
-      uses: actions/setup-python@v3
-      with:
-        python-version: '3.8'
     - name: Install dependencies
       run: |
         python3 -m pip install --upgrade pip wheel setuptools setuptools-scm
-        python3 -m pip install virtualenv
         python3 -m pip install build
     - name: Build package
       run: python3 -m build
-    - name: Build bdist package
-      run: python3 setup.py bdist_wheel
-    - name: Publish package
-      if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
-      uses: pypa/gh-action-pypi-publish@master
+    - name: Publish package to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
       with:
         user: __token__
         password: ${{ secrets.PYPI_API_TOKEN }}
-        verify_metadata: false
+        verify_metadata: true
+        skip_existing: false

.pre-commit-config.yaml

@@ -1,14 +1,14 @@
 repos:
 - repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
-  rev: v2.12.0
+  rev: v2.15.0
   hooks:
   - id: pretty-format-yaml
     args: [--autofix, --indent, '2']
   - id: pretty-format-toml
     args: [--autofix]
 
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.5.0
+  rev: v6.0.0
   hooks:
   - id: check-yaml
   - id: end-of-file-fixer
@@ -19,19 +19,23 @@ repos:
 #    hooks:
 #    id: black
 - repo: https://github.com/python-jsonschema/check-jsonschema
-  rev: 0.27.3
+  rev: 0.36.0
   hooks:
   - id: check-github-actions
   - id: check-github-workflows
 
-- repo: https://github.com/pre-commit/mirrors-yapf
-  rev: v0.32.0
+- repo: https://github.com/google/yapf
+  rev: v0.43.0
   hooks:
   - id: yapf
-    additional_dependencies: [toml]
+    name: yapf
+    language: python
+    entry: yapf
+    args: [-i]
+    types: [python]
 
 - repo: https://github.com/igorshubovych/markdownlint-cli
-  rev: v0.38.0
+  rev: v0.47.0
   hooks:
   - id: markdownlint-fix
     entry: markdownlint -f '**/*.md' --disable MD013 MD036 MD046 MD033 MD041 MD040

README.md

@@ -12,7 +12,7 @@ objects (phase, amplitude, amplitude-phase) having the self-calibrated dataset a
 ## Requirements
 
 1. `Python == 3.8`
-2. Check CASA pip current version requirements [here](https://casadocs.readthedocs.io/en/stable/notebooks/introduction.html#Modular-Packages).
+2. Check [CASA pip package requirements](https://casadocs.readthedocs.io/en/stable/notebooks/introduction.html#Modular-Packages) for current version requirements.
 3. Check the `requirements.txt` file.
 
 ## Installation