Test PR on all commits

.github/CODEOWNERS

@@ -0,0 +1 @@
+*   @VincentAuriau

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,51 @@
+---
+name: Bug report
+about: Report a bug you have encountered
+title: "[BUG]"
+labels: bug
+assignees: ''
+
+---
+
+---
+name: 🐛 Bug report
+about: If something isn't working 🔧
+title: ''
+labels: bug
+assignees:
+---
+
+## 🐛 Bug Report
+
+<!-- A clear and concise description of what the bug is. -->
+
+## 🔬 How To Reproduce
+
+Steps to reproduce the behavior:
+
+1. ...
+
+### Code sample
+
+<!-- If applicable, attach a minimal code sample to reproduce the decried issue. -->
+
+### Environment
+
+* OS: [e.g. Linux / Windows / macOS]
+* Python version, get it with:
+
+```bash
+python --version
+```
+
+### Screenshots
+
+<!-- If applicable, add screenshots to help explain your problem. -->
+
+## 📈 Expected behavior
+
+<!-- A clear and concise description of what you expected to happen. -->
+
+## 📎 Additional context
+
+<!-- Add any other context about the problem here. -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,32 @@
+---
+name: Feature request
+about: Suggest an idea to improve Choice-Learn
+title: "[ADD]"
+labels: new feature
+assignees: ''
+
+---
+
+---
+name: 🚀 Feature request
+about: Suggest an idea for this project 🏖
+title: ''
+labels: enhancement
+assignees:
+---
+
+## 🚀 Feature Request
+
+<!-- A clear and concise description of the feature proposal. -->
+
+## 🔈 Motivation
+
+<!-- Please describe the motivation for this proposal. -->
+
+## 🛰 Alternatives
+
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
+
+## 📎 Additional context
+
+<!-- Add any other context or screenshots about the feature request here. -->

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,25 @@
+---
+name: Question
+about: Any question about Choice-Learn?
+title: ''
+labels: question
+assignees: ''
+
+---
+
+---
+name: ❓ Question
+about: Any question about Choice-Learn?
+title: ''
+labels: question
+assignees:
+---
+
+## ❓ Problem
+<!-- What do you want to do? What is blocking you? -->
+
+## 🔬 Considered solutions
+<!-- What have you tried but didn't work? -->
+
+## 💡 How can we help ?
+<!-- Be as clear and concise as possible so we can help you in the most efficient way.-->

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,6 +1,6 @@
 ## Description of the goal of the PR
 
-Description: 
+Description:
 
 ## Changes this PR introduces (fill it before implementation)
 
@@ -15,4 +15,4 @@ Description:
 - [ ] I have updated the requirements files if a new package is used
 - [ ] I have tested my code
 - [ ] The CI pipeline passes
-- [ ] I have performed a self-review of my code
+- [ ] I have performed a self-review of my code

.github/actions/build-draft.yaml

@@ -0,0 +1,23 @@
+name: Open Journals PDF Generator
+description: Create a draft PDF for an Open Journals paper
+inputs:
+  journal:
+    description: Target journal, must be either "joss" or "jose"
+    required: false
+    default: joss
+  paper-path:
+    description: >-
+        Path to the main paper Markdown file, relative to the
+        project's root directory.
+    required: false
+    default: 'paper.md'
+runs:
+  using: docker
+  image: 'docker://openjournals/inara:latest'
+  env:
+    GIT_SHA: $GITHUB_SHA
+    JOURNAL: ${{ inputs.journal }}
+  args:
+    - -o pdf
+    - -p
+    - ${{ inputs.paper-path }}

.github/actions/build-draft/action.yaml

@@ -0,0 +1,23 @@
+name: Open Journals PDF Generator
+description: Create a draft PDF for an Open Journals paper
+inputs:
+  journal:
+    description: Target journal, must be either "joss" or "jose"
+    required: false
+    default: joss
+  paper-path:
+    description: >-
+        Path to the main paper Markdown file, relative to the
+        project's root directory.
+    required: false
+    default: 'paper.md'
+runs:
+  using: docker
+  image: 'docker://openjournals/inara:latest'
+  env:
+    GIT_SHA: $GITHUB_SHA
+    JOURNAL: ${{ inputs.journal }}
+  args:
+    - -o pdf
+    - -p
+    - ${{ inputs.paper-path }}

.github/actions/publish/action.yaml

@@ -0,0 +1,139 @@
+name: "PyPI Poetry Publish"
+description: "GitHub action to automate publishing packages to PyPI - from code-specialist."
+
+
+inputs:
+  ACCESS_TOKEN:
+    description: "Access Token for GitHub with write access on the repository"
+    required: true
+  PYTHON_VERSION:
+    description: "Python Version"
+    required: false
+    default: "3.10"
+  PACKAGE_DIRECTORY:
+    description: "Directory of the package"
+    required: false
+    default: "./"
+  PUBLISH_REGISTRY_PASSWORD:
+    description: "Password for the user to publish to PyPI. May also be a Token - requires the `PUBLISH_REGISTRY_USERNAME` to be `__token__`"
+    required: true
+  PUBLISH_REGISTRY_USERNAME:
+    description: "The username for the registry. Defaults to __token__"
+    required: false
+    default: "__token__"
+  POETRY_VERSION:
+    description: "The version of Poetry to use"
+    required: false
+    default: ""
+  POETRY_CORE_VERSION:
+    description: "The version of Poetry Core to use"
+    required: false
+    default: ""
+  BRANCH:
+    description: "Branch to publish from"
+    required: false
+    default: "main"
+  POETRY_DEPENDENCY_REGISTRY_URL:
+    description: "Allows to define a custom registry to be used by Poetry for dependency installation"
+    required: false
+  POETRY_DEPENDENCY_REGISTRY_NAME:
+    description: "The name used for the custom registry in the dependencies"
+    required: false
+  POETRY_DEPENDENCY_REGISTRY_USERNAME:
+    description: "The username for the custom registry"
+    required: false
+  POETRY_DEPENDENCY_REGISTRY_PASSWORD:
+    description: "The password for the custom registry"
+    required: false
+  POETRY_DEPENDENCY_REGISTRY_AUTH:
+    description: "The authentication type for the custom registry"
+    required: false
+    default: "http-basic"
+  PUBLISH_REGISTRY:
+    description: "The registry to publish to"
+    required: false
+    default: "https://upload.pypi.org/legacy/"
+  UPDATE_CODE_VERSION:
+    description: "Whether or not to apply the version update in the code"
+    required: false
+    default: "true"
+  PUSH_BRANCH:
+    description: "Which branch to push the changes to"
+    required: false
+    default: "main"
+
+runs:
+  using: composite
+  steps:
+    - name: display inputs
+      run: |
+        echo ${{ inputs.BRANCH }}
+      shell: bash
+
+    - name: Checkout Repository
+      uses: actions/checkout@v4
+      with:
+        ref: ${{ inputs.BRANCH }}
+        token: ${{ inputs.ACCESS_TOKEN }}
+
+    - name: check install
+      run: |
+        git status
+        git branch
+      shell: bash
+
+    - name: Install poetry
+      run: pip install poetry${{ inputs.POETRY_VERSION != '' && format('=={0}', inputs.POETRY_VERSION) || '' }} poetry-core${{ inputs.POETRY_CORE_VERSION != '' && format('=={0}', inputs.POETRY_CORE_VERSION) || '' }}
+      shell: bash
+
+    - name: Set up Python ${{ inputs.PYTHON_VERSION }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ inputs.PYTHON_VERSION }}
+        cache: poetry
+        check-latest: true
+
+    - name: Set GitHub Tag as Package Version
+      run: |
+        if ${{ inputs.UPDATE_CODE_VERSION }}
+        then
+          vname="${{ github.event.release.tag_name }}"
+          vname=${vname:1}
+          echo $vname
+          sed -i -r 's/__version__ *= *".*"/__version__ = "'"$vname"'"/g' ${{ inputs.PACKAGE_DIRECTORY }}__init__.py
+          sed -i '0,/version =.*/s//version = "'"$vname"'"/' ./pyproject.toml
+        fi
+      shell: bash
+
+    - name: Add and Commit Version
+      run: |
+        if ${{ inputs.UPDATE_CODE_VERSION }}
+        then
+          git checkout -b ${{ inputs.PUSH_BRANCH }}
+          git add ${{ inputs.PACKAGE_DIRECTORY }}__init__.py ./pyproject.toml
+          git config user.name 'VincentAuriau'
+          git config user.email '22350719+VincentAuriau@users.noreply.github.com'
+          git commit -m "Change version to ${{ github.event.release.tag_name }}" --allow-empty
+          git push origin HEAD:${{ inputs.PUSH_BRANCH }}
+        fi
+      shell: bash
+
+    - name: Install dependencies
+      if: inputs.POETRY_DEPENDENCY_REGISTRY_URL != ''
+      run: |
+        poetry config repositories.${{ inputs.POETRY_DEPENDENCY_REGISTRY_NAME }} ${{ inputs.POETRY_DEPENDENCY_REGISTRY_URL }}
+        poetry config ${{ inputs.POETRY_DEPENDENCY_REGISTRY_AUTH }}.${{ inputs.POETRY_DEPENDENCY_REGISTRY_NAME }} ${{ inputs.POETRY_DEPENDENCY_REGISTRY_USERNAME }} ${{ inputs.POETRY_DEPENDENCY_REGISTRY_PASSWORD }}
+        poetry install --no-root
+      shell: bash
+
+    - name: Install dependencies
+      if: inputs.POETRY_DEPENDENCY_REGISTRY_URL == ''
+      run: |
+        poetry install --no-root
+      shell: bash
+
+    - name: Build and Publish
+      run: |
+        poetry config repositories.publish ${{ inputs.PUBLISH_REGISTRY }}
+        poetry publish -p ${{ inputs.PUBLISH_REGISTRY_PASSWORD }} -u ${{ inputs.PUBLISH_REGISTRY_USERNAME }} -r publish --build
+      shell: bash

.github/workflows/ci.yaml

@@ -1,25 +1,41 @@
-name: CI
+name: Build
 
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - main  # Run on pushes to main
+  pull_request:   # Run on pull requests
 
 jobs:
   CI:
-    name: Launching CI
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.8', '3.9', '3.10']
+        python-version: ['3.9', '3.10', '3.11', '3.12']
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
 
       - name: Install requirements
         run: |
           python -m pip install --upgrade pip
           pip install -r requirements-developer.txt
-      - name: Run Pre commit hook (formatting, linting & tests)
-        run: pre-commit run --all-files --hook-stage pre-push --show-diff-on-failure
+          pip list
+
+      - name: Build coverage file
+        run: |
+          pytest -n auto --junitxml=pytest.xml --cov-report=term-missing --cov=choice_learn tests/ | tee pytest-coverage.txt
+          cat pytest-coverage.txt
+
+      - name: Pytest coverage comment
+        uses: VincentAuriau/pytest-coverage-comment@main
+        with:
+          pytest-coverage-path: ./pytest-coverage.txt
+          junitxml-path: ./pytest.xml
+          issue-number: ${{ github.event.pull_request.number || '101' }}
+          unique-id-for-comment: ${{ matrix.python-version }}
+          title: 'Coverage Report for Python ${{ matrix.python-version }}'

.github/workflows/deploy_docs.yaml

@@ -10,9 +10,9 @@ jobs:
     name: Deploy docs
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Python 3.10
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: "3.10"
 
@@ -24,5 +24,3 @@ jobs:
         run: |
           mkdocs build
           mkdocs gh-deploy --force
-
-