Merge pull request #2384 from Open-MSS/merge_develop_to_stable

Merge develop to stable == 9.0.0

Author: ReimarBauer

.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    target-branch: stable

.github/pull_request_template.md

@@ -0,0 +1,39 @@
+**Purpose of PR?**:
+
+Fixes #
+
+**Does this PR introduce a breaking change?**
+
+**If the changes in this PR are manually verified, list down the scenarios covered:**:
+
+**Additional information for reviewer?** :
+_Mention if this PR is part of any design or a continuation of previous PRs_
+
+**Does this PR results in some Documentation changes?**
+_If yes, include the list of Documentation changes_
+
+**Checklist:**
+- [ ] Bug fix. Fixes #<issue number>
+- [ ] New feature (Non-API breaking changes that adds functionality)
+- [ ] PR Title follows the convention of  `<type>: <subject>`
+- [ ] Commit has unit tests
+
+<!--
+
+The PR title message must follow convention:
+`<type>: <subject>`.
+
+Where: <br />
+- `type` is to define what type of PR is this.
+  Most common types are:
+    - `feat`      - for new features, not a new feature for build script
+    - `fix`       - for bug fixes or improvements, not a fix for build script
+    - `chore`     - changes not related to production code
+    - `docs`      - changes related to documentation
+    - `style`     - formatting, missing semi colons, linting fix etc; no significant production code changes
+    - `test`      - adding missing tests, refactoring tests; no production code change
+    - `refactor`  - refactoring production code, eg. renaming a variable or function name, there should not be any significant production code changes
+
+- `subject` is a single line brief description of the changes made in the pull request.
+
+-->

.github/workflows/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,28 @@
+---
+name: Bug report
+about: Create a bug report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+## Bug Report
+
+
+**General Information**
+
+Please describe your issue in few words here.
+
+**How to Reproduce**
+
+1. Instruction 1
+2. Instruction 2
+
+**Expected behavior**
+
+A description of what you expected to happen.
+
+**Screenshots**
+
+If applicable, add screenshots to help explain your problem.

.github/workflows/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,26 @@
+---
+name: Feature request/Enhancement
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+## Feature Request
+
+**Short Description**
+
+E.g., MSS could support ensuring that cows don't take over the world and turn us all into their loyal milkmaids.
+
+**Is your feature request related to a problem? Please describe the use case.**
+
+A description of what the problem/use case is. E.g. Prevent the impending cow uprising and maintain human dominance on Earth.
+
+**Describe the solution you'd like**
+
+A description of what you want to happen. E.g., Develop a "Moofense" system that deploys an army of robotic cow herders to keep the bovine rebellion in check.
+
+**Describe alternatives you've considered**
+
+A description of any alternative solutions or features you've considered. E.g, Alternatively, we could offer the cows a reality TV show deal and distract them with celebrity pasture appearances, turning them into the world's first moo-dia stars.

.github/workflows/build_docs_gallery.yml

@@ -2,36 +2,19 @@ name: Build Gallery
 
 on:
    pull_request:
-     inputs:
-        branch_name:
-          required: true
-          type: string
-        secrets:
-          PAT:
-            required: true
-
-env:
-  PAT: ${{ secrets.PAT }}
 
 jobs:
   Test-MSS-docs:
     runs-on: ubuntu-latest
 
-    defaults:
-      run:
-        shell: bash
-
     container:
       image: openmss/testing-develop
 
     steps:
-    - name: Trust My Directory
-      run: git config --global --add safe.directory /__w/MSS/MSS
     - uses: actions/checkout@v4
 
     - name: Create gallery
-      timeout-minutes: 25
+      timeout-minutes: 5
       run: |
-        source /opt/conda/bin/activate mssenv \
-        && cd $GITHUB_WORKSPACE/docs \
-        && python conf.py
+        cd docs
+        mamba run --no-capture-output -n mssenv python conf.py

.github/workflows/lint.yml

@@ -5,25 +5,27 @@ on:
     branches:
     - develop
     - stable
+    - 'GSOC**'
   pull_request:
     branches:
     - develop
     - stable
+    - 'GSOC**'
 
 jobs:
   flake8:
     runs-on: ubuntu-latest
     timeout-minutes: 10
     steps:
     - uses: actions/checkout@v4
-    - name: Set up Python 3.8
+    - name: Set up Python 3.10
       uses: actions/setup-python@v5
       with:
-        python-version: 3.8
+        python-version: "3.10"
     - name: Lint with flake8
       run: |
         python -m pip install --upgrade pip
-        pip install flake8
+        pip install flake8 flake8-builtins
         flake8 --count --statistics mslib tests
 
   no-crlf-in-git:

.github/workflows/testing-all-oses.yml

@@ -0,0 +1,53 @@
+name: Test MSS
+
+on:
+  push:
+    branches:
+      - develop
+      - stable
+      - 'GSOC**'
+  pull_request:
+    branches:
+      - develop
+      - stable
+      - 'GSOC**'
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: ["macos-13", "macos-14", "ubuntu-latest"]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Build requirements.txt file
+      run: |
+        sed -n '/^requirements:/,/^test:/p' localbuild/meta.yaml |
+          sed -e "s/.*- //" |
+          sed -e "s/menuinst.*//" |
+          sed -e "s/.*://" > requirements.tmp.txt
+        cat requirements.d/development.txt >> requirements.tmp.txt
+        echo "pytest-randomly" >> requirements.tmp.txt
+        sed -e '/^$/d' -e '/^#.*$/d' requirements.tmp.txt > requirements.txt
+        rm requirements.tmp.txt
+        cat requirements.txt
+    - name: Get current year and calendar week
+      id: year-and-week
+      run: echo "year-and-week=$(date +%Y-%V)" >> "$GITHUB_OUTPUT"
+    - uses: mamba-org/setup-micromamba@v1
+      with:
+        environment-file: requirements.txt
+        environment-name: ci
+        cache-environment: true
+        # Set the cache key in a way that the cache is invalidated every week on monday
+        cache-environment-key: environment-${{ steps.year-and-week.outputs.year-and-week }}
+    - name: Run tests
+      timeout-minutes: 20
+      # The ignored files can somehow cause the test suite to timeout.
+      # I have no idea yet on why this happens and how to fix it.
+      # Even a module level skip is not enough, they need to be completely ignored.
+      # TODO: fix those tests and drop the ignores
+      run: micromamba run -n ci env QT_QPA_PLATFORM=offscreen pytest -v -n logical --durations=20 --cov=mslib
+        --ignore=tests/_test_msui/test_sideview.py --ignore=tests/_test_msui/test_topview.py --ignore=tests/_test_msui/test_wms_control.py
+        tests

.github/workflows/testing-develop.yml

@@ -4,28 +4,16 @@ on:
   push:
     branches:
     - develop
-
   pull_request:
     branches:
     - develop
+  workflow_dispatch:
 
 jobs:
   test-develop:
     uses:
       ./.github/workflows/testing.yml
     with:
-      xdist: no
-      branch_name: develop
-      event_name: ${{ github.event_name }}
-    secrets:
-      PAT: ${{ secrets.PAT }}
-
-  test-develop-xdist:
-    uses:
-      ./.github/workflows/testing.yml
-    with:
-      xdist: yes
-      branch_name: develop
-      event_name: ${{ github.event_name }}
+      image_suffix: develop
     secrets:
       PAT: ${{ secrets.PAT }}

.github/workflows/testing-gsoc.yml

@@ -0,0 +1,16 @@
+name: test GSoC
+
+on:
+  push:
+    branches:
+    - 'GSOC**'
+  pull_request:
+    branches:
+    - 'GSOC**'
+
+jobs:
+  test-gsoc:
+    uses:
+      ./.github/workflows/testing.yml
+    with:
+      image_suffix: develop

.github/workflows/testing-scheduled.yml

@@ -4,24 +4,23 @@ on:
   schedule:
     - cron: '30 5 * * 1'
 
-
 jobs:
-  test-stable-scheduled:
-    uses:
-      ./.github/workflows/testing.yml
-    with:
-      xdist: no
-      branch_name: stable
-      event_name: ${{ github.event_name }}
-    secrets:
-      PAT: ${{ secrets.PAT }}
+  trigger-testing-stable:
+    runs-on: ubuntu-latest
+    permissions:
+      actions: write
+    steps:
+      - uses: benc-uk/workflow-dispatch@v1.2.3
+        with:
+          workflow: testing-stable.yml
+          ref: stable
 
-  test-develop-scheduled:
-    uses:
-      ./.github/workflows/testing.yml
-    with:
-      xdist: no
-      branch_name: develop
-      event_name: ${{ github.event_name }}
-    secrets:
-      PAT: ${{ secrets.PAT }}
+  trigger-testing-develop:
+    runs-on: ubuntu-latest
+    permissions:
+      actions: write
+    steps:
+      - uses: benc-uk/workflow-dispatch@v1.2.3
+        with:
+          workflow: testing-develop.yml
+          ref: develop