Merge branch 'main' of github.com:daisybio/drevalpy

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,33 @@
+---
+name: Bug report
+about: Create a bug report to help us improve
+title: "Bug Summary"
+labels: "bug"
+assignees: ""
+---
+
+**Describe the bug**
+
+<!-- A clear and concise description of what the bug is. -->
+
+**To Reproduce**
+
+Steps to reproduce the behavior:
+
+1. ...
+2. ...
+3. ...
+
+**Expected behavior**
+
+<!-- A clear and concise description of what you expected to happen. -->
+
+**System [please complete the following information]:**
+
+- OS: e.g. [Ubuntu 18.04]
+- Language Version: [e.g. Python 3.8]
+- Virtual environment: [e.g. Conda]
+
+**Additional context**
+
+<!-- Add any other context about the problem here. -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest a new feature
+title: "Feature Request Summary"
+labels: "enhancement"
+assignees: ""
+---
+
+**Is your feature request related to a problem? Please describe.**
+
+<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when ... -->
+
+**Describe the solution you would like**
+
+<!-- A clear and concise description of what you want to happen. -->
+
+**Additional context**
+
+<!-- Add any other context or screenshots about the feature request here. -->

.github/ISSUE_TEMPLATE/general_question.md

@@ -0,0 +1,12 @@
+---
+name: General question
+about: Ask a question about anything related to this project
+title: "Question"
+labels: "question"
+assignees: ""
+---
+
+**Question**
+
+<!-- Please ask your question here. It can be about the usage of this project, the internals, the implementation or whatever interests you.
+Please use the BUG template for bugs and the FEATURE REQUEST template for feature requests. -->

.github/dependabot.yml

@@ -0,0 +1,45 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: weekly
+    open-pull-requests-limit: 3
+    target-branch: development
+    labels:
+      - DEPENDABOT
+    commit-message:
+      prefix: "[DEPENDABOT]"
+
+  - package-ecosystem: pip
+    directory: "/.github/workflows"
+    schedule:
+      interval: weekly
+    open-pull-requests-limit: 3
+    target-branch: development
+    labels:
+      - DEPENDABOT
+    commit-message:
+      prefix: "[DEPENDABOT]"
+
+  - package-ecosystem: pip
+    directory: "/docs"
+    schedule:
+      interval: weekly
+    open-pull-requests-limit: 3
+    target-branch: development
+    labels:
+      - DEPENDABOT
+    commit-message:
+      prefix: "[DEPENDABOT]"
+
+  - package-ecosystem: pip
+    directory: "/"
+    schedule:
+      interval: weekly
+    open-pull-requests-limit: 3
+    target-branch: development
+    labels:
+      - DEPENDABOT
+    commit-message:
+      prefix: "[DEPENDABOT]"

.github/labels.yml

@@ -0,0 +1,69 @@
+---
+# Labels names are important as they are used by Release Drafter to decide
+# regarding where to record them in changelog or if to skip them.
+#
+# The repository labels will be automatically configured using this file and
+# the GitHub Action https://github.com/marketplace/actions/github-labeler.
+- name: breaking
+  description: Breaking Changes
+  color: bfd4f2
+- name: bug
+  description: Something isn't working
+  color: d73a4a
+- name: build
+  description: Build System and Dependencies
+  color: bfdadc
+- name: ci
+  description: Continuous Integration
+  color: 4a97d6
+- name: dependencies
+  description: Pull requests that update a dependency file
+  color: 0366d6
+- name: documentation
+  description: Improvements or additions to documentation
+  color: 0075ca
+- name: duplicate
+  description: This issue or pull request already exists
+  color: cfd3d7
+- name: enhancement
+  description: New feature or request
+  color: a2eeef
+- name: github_actions
+  description: Pull requests that update Github_actions code
+  color: "000000"
+- name: good first issue
+  description: Good for newcomers
+  color: 7057ff
+- name: help wanted
+  description: Extra attention is needed
+  color: 008672
+- name: invalid
+  description: This doesn't seem right
+  color: e4e669
+- name: performance
+  description: Performance
+  color: "016175"
+- name: python
+  description: Pull requests that update Python code
+  color: 2b67c6
+- name: question
+  description: Further information is requested
+  color: d876e3
+- name: refactoring
+  description: Refactoring
+  color: ef67c4
+- name: removal
+  description: Removals and Deprecations
+  color: 9ae7ea
+- name: style
+  description: Style
+  color: c120e5
+- name: testing
+  description: Testing
+  color: b1fc6f
+- name: wontfix
+  description: This will not be worked on
+  color: ffffff
+- name: skip-changelog
+  description: Changes that should be omitted from the release notes
+  color: ededed

.github/pull_request_template.md

@@ -0,0 +1,22 @@
+<!-- Many thanks for contributing to this project! -->
+
+**PR Checklist**
+
+<!-- Please fill in the appropriate checklist below (delete whatever is not relevant). These are the most common things requested on pull requests (PRs). -->
+
+- [ ] This comment contains a description of changes (with reason)
+- [ ] Referenced issue is linked
+- [ ] If you've fixed a bug or added code that should be tested, add tests!
+- [ ] Documentation in `docs` is updated
+
+**Description of changes**
+
+<!-- Please state what you've changed and how it might affect the user. -->
+
+**Technical details**
+
+<!-- Please state any technical details such as limitations, reasons for additional dependencies, benchmarks etc. here. -->
+
+**Additional context**
+
+<!-- Add any other context or screenshots here. -->

.github/release-drafter.yml

@@ -0,0 +1,54 @@
+name-template: "0.8.0 🌈" # <<COOKIETEMPLE_FORCE_BUMP>>
+tag-template: 0.8.0 # <<COOKIETEMPLE_FORCE_BUMP>>
+exclude-labels:
+  - "skip-changelog"
+
+categories:
+  - title: "🚀 Features"
+    labels:
+      - feature
+      - enhancement
+  - title: "🐛 Bug Fixes"
+    labels:
+      - fix
+      - bugfix
+      - bug
+  - title: "🧰 Maintenance"
+    label: chore
+  - title: ":package: Dependencies"
+    labels:
+      - dependencies
+      - build
+      - dependabot
+      - DEPENDABOT
+version-resolver:
+  major:
+    labels:
+      - major
+  minor:
+    labels:
+      - minor
+  patch:
+    labels:
+      - patch
+  default: patch
+autolabeler:
+  - label: chore
+    files:
+      - "*.md"
+    branch:
+      - '/docs{0,1}\/.+/'
+  - label: bug
+    branch:
+      - /fix\/.+/
+    title:
+      - /fix/i
+  - label: enhancement
+    branch:
+      - /feature\/.+/
+    body:
+      - "/JIRA-[0-9]{1,4}/"
+template: |
+  ## Changes
+
+  $CHANGES

.github/workflows/build_package.yml

@@ -0,0 +1,35 @@
+name: Build DrEvalPy Package
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    if: "!contains(github.event.head_commit.message, '[skip ci]') && !contains(github.event.head_commit.message, '[ci skip]')"
+    strategy:
+      matrix:
+        os: [macos-latest, ubuntu-latest, windows-latest]
+        python: ["3.9", "3.10"]
+
+    steps:
+      - uses: actions/checkout@v4
+        name: Check out source-code repository
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+
+      - name: Install Poetry
+        run: |
+          pip install poetry
+          poetry --version
+
+      - name: Build package
+        run: poetry build --ansi
+
+      - name: Install required twine packaging dependencies
+        run: pip install setuptools wheel twine
+
+      - name: Check twine package
+        run: twine check dist/*

.github/workflows/labeler.yml

@@ -0,0 +1,19 @@
+name: Labeler
+
+on:
+  push:
+    branches:
+      - main
+      - master
+
+jobs:
+  labeler:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out the repository
+        uses: actions/checkout@v4
+
+      - name: Run Labeler
+        uses: crazy-max/[email protected]
+        with:
+          skip-delete: true

.github/workflows/publish-docker.yml

@@ -0,0 +1,64 @@
+name: Create and publish a Docker image
+
+# Configures this workflow to run every time a release is published
+on:
+  release:
+    types: [published]
+
+# Defines two custom environment variables for the workflow.
+# These are used for the Container registry domain, and a name for the Docker image that this workflow builds.
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+# There is a single job in this workflow. It's configured to run on the latest available version of Ubuntu.
+jobs:
+  build-and-push-image:
+    runs-on: ubuntu-latest
+
+    # Sets the permissions granted to the `GITHUB_TOKEN` for the actions in this job.
+    permissions:
+      contents: read
+      packages: write
+      attestations: write
+      id-token: write
+
+    steps:
+      # Necessary for buildx
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup QEMU
+        uses: docker/setup-qemu-action@v3
+
+      # Set up BuildKit Docker container builder to be able to build
+      # multi-platform images and export cache
+      # https://github.com/docker/setup-buildx-action
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      # This step uses the `docker/build-push-action` action to build the image, based on your repository's `Dockerfile`. If the build succeeds, it pushes the image to GitHub Packages.
+      # It uses the `context` parameter to define the build's context as the set of files located in the specified path. For more information, see "[Usage](https://github.com/docker/build-push-action#usage)" in the README of the `docker/build-push-action` repository.
+      # It uses the `tags` and `labels` parameters to tag and label the image with the output from the "meta" step.
+      - name: Build and push Docker image
+        id: build-and-push
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          platforms: linux/amd64,linux/arm64