Merge pull request #60 from neutrons/release/v1.5-prod

Release v1.5 to Production

Author: darshdinger

.gitattributes

@@ -0,0 +1,2 @@
+# SCM syntax highlighting & preventing 3-way merges
+pixi.lock merge=binary linguist-language=YAML linguist-generated=true

.github/workflows/publish.yml

@@ -22,27 +22,16 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
         with:
           fetch-depth: 0
-      - uses: conda-incubator/setup-miniconda@v3
-        with:
-          auto-update-conda: true
-          channels: conda-forge,defaults
-          mamba-version: "*"
-          environment-file: environment.yml
-          cache-environment-key: ${{ runner.os }}-env-${{ hashFiles('**/environment.yml') }}
-          cache-downloads-key: ${{ runner.os }}-downloads-${{ hashFiles('**/environment.yml') }}
-      - name: Install requirements
-        run: |
-          # --quiet should turn off progress bars to make logs more readable
-          conda env create
+      - name: Setup Pixi
+        uses: prefix-dev/setup-pixi@v0.9.3
 
       - name: Create tag version
         id: tag
         run: |
-          conda activate livedata
-          echo "tag=$(versioningit)" >> $GITHUB_OUTPUT
+          echo "tag=$(pixi run versioningit)" >> $GITHUB_OUTPUT
 
       - name: Create latest tag version
         id: latest_tag
@@ -87,8 +76,8 @@ jobs:
           tags: ${{ env.REGISTRY }}/${{ github.repository }}/live_data_server:${{ steps.latest_tag.outputs.latest_tag }}
           push: true
 
-      - name: Push version tag only for main branch
-        if: github.ref == 'refs/heads/main'
+      - name: Push version tag for branches qa and main
+        if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/qa'
         uses: docker/build-push-action@v6
         with:
           context: .

.github/workflows/unittest.yml

@@ -10,10 +10,6 @@ on:
 jobs:
   linux:
     runs-on: ubuntu-latest
-    defaults:
-      run:
-        shell: bash -l {0}
-
     env:
       DATABASE_NAME: livedatadb
       DATABASE_USER: livedatauser
@@ -27,17 +23,10 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
-      - name: Setup Conda environment
-        uses: conda-incubator/setup-miniconda@v3
-        with:
-          auto-update-conda: true
-          channels: conda-forge,defaults
-          mamba-version: "*"
-          environment-file: environment.yml
-          cache-environment-key: ${{ runner.os }}-env-${{ hashFiles('**/environment.yml') }}
-          cache-downloads-key: ${{ runner.os }}-downloads-${{ hashFiles('**/environment.yml') }}
+      - name: Setup Pixi
+        uses: prefix-dev/setup-pixi@v0.9.3
 
       - name: Start docker containers
         run: |
@@ -48,7 +37,7 @@ jobs:
         run: sleep 30
 
       - name: Run unit tests
-        run: python -m pytest tests/
+        run: pixi run test
 
       - name: Stop the coverage process
         # Stopping the coverage process allows the code coverage to be written to disk
@@ -58,19 +47,18 @@ jobs:
         run: docker cp live_data_server-django-1:/var/www/livedata/app /tmp/
 
       - name: Combine and show code coverage
-        shell: bash -l {0}
         run: |
-          cd /tmp/app
-          coverage combine
-          coverage xml
-          cp coverage.xml $OLDPWD
-          coverage report
+          pixi run coverage combine --data-file=/tmp/app/.coverage
+          cp /tmp/app/.coverage src
+          cd src
+          pixi run coverage xml
+          pixi run coverage report
 
       - name: Bring down docker containers completely now
         # This will completely remove the containers
         run: docker compose down
 
       - name: Upload coverage reports to Codecov
-        uses: codecov/codecov-action@v4
+        uses: codecov/codecov-action@v5
         with:
           token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/update-lockfiles.yml

@@ -0,0 +1,36 @@
+name: Update lockfiles
+
+permissions:
+  contents: write
+  pull-requests: write
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: 0 5 1 * *
+
+jobs:
+  pixi-update:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - name: Set up pixi
+        uses: prefix-dev/setup-pixi@v0.9.3
+        with:
+          run-install: false
+      - name: Update lockfiles
+        run: |
+          set -o pipefail
+          pixi update --json | pixi exec pixi-diff-to-markdown >> diff.md
+      - name: Create pull request
+        uses: peter-evans/create-pull-request@v8
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: Update pixi lockfile
+          title: Update pixi lockfile
+          body-path: diff.md
+          branch: update-pixi
+          base: next  # change this to the default branch of your repository
+          labels: pixi
+          delete-branch: true
+          add-paths: pixi.lock

.gitignore

@@ -67,3 +67,6 @@ target/
 
 # Ruff cache
 .ruff_cache
+# pixi environments
+.pixi/*
+!.pixi/config.toml

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.6.0
+  rev: v6.0.0
   hooks:
     - id: check-added-large-files
       args: [--maxkb=8192]
@@ -11,7 +11,7 @@ repos:
     - id: end-of-file-fixer
     - id: trailing-whitespace
 - repo: https://github.com/astral-sh/ruff-pre-commit
-  rev: v0.6.1
+  rev: v0.14.10
   hooks:
     - id: ruff
       args: [--fix, --exit-non-zero-on-fix]

.readthedocs.yml

@@ -1,14 +1,21 @@
 version: 2
 
 build:
-  os: ubuntu-22.04
+  os: "ubuntu-24.04"
   tools:
-    python: "mambaforge-4.10"
+    python: "3.11"
+  jobs:
+    create_environment:
+      - asdf plugin add pixi
+      - asdf install pixi latest
+      - asdf global pixi latest
+    install:
+      - pixi install
+    build:
+      html:
+        - pixi run sphinx-build -T -b html docs $READTHEDOCS_OUTPUT/html
 
 sphinx:
   builder: html
   configuration: docs/conf.py
   fail_on_warning: true
-
-conda:
-  environment: environment.yml

README.md

@@ -13,19 +13,19 @@ Developer documentation at <https://livedata-ornl.readthedocs.io/en/latest/>
 
 ### Dependencies
 
-- [Conda](https://conda.io/projects/conda/en/latest/user-guide/install/index.html) / [Mamba/Miniforge](https://github.com/conda-forge/miniforge)
+- [Pixi](https://pixi.sh/latest/installation/)
 - [Docker](https://docs.docker.com/engine/install/) and [Docker Compose](https://docs.docker.com/compose/install/)
 - [direnv](https://direnv.net/) (optional)
 
 ### Setup for Local Development
 
 1.  Clone the repository and `cd` into the project directory.
 
-1.  Create a conda environment `livedata`, containing all the dependencies
+1.  Create a pixi environment `live_data_server`, containing all the dependencies
 
     ```python
-    conda env create -f environment.yml
-    conda activate livedata
+    pixi install
+    pixi shell
     ```
 
 1.  To deploy this application locally, you will need to set a number of environment variables,
@@ -69,8 +69,8 @@ Developer documentation at <https://livedata-ornl.readthedocs.io/en/latest/>
 After the setup, with the server running, you can test your setup by running `pytest`:
 
 ```bash
-pytest tests/test_post_get.py
-# or simply
+pixi run test
+# or
 pytest
 ```
 
@@ -95,7 +95,7 @@ Additional documentation is available in the `docs` directory. To build the docu
 run the following command from within directory `docs/`:
 
 ```bash
-make html
+pixi run -e docs make html
 ```
 
 The documentation will be built in the `docs/_build/html` directory. To view the documentation,

deploy/django/Dockerfile

@@ -1,10 +1,10 @@
-FROM continuumio/miniconda3:23.10.0-1 AS base
+FROM ghcr.io/prefix-dev/pixi:0.50.2-jammy AS base
 
 ### System dependencies and cron job setup
 RUN apt-get update -y && \
     # apt upgrade -y && \
     apt-get install -y \
-    vim cron
+    vim cron wget
 
 # Set up cron job to purge expired data once a month
 COPY scripts/periodic-purge.sh /var/opt/
@@ -16,8 +16,9 @@ RUN echo "0 0 1 * * /var/opt/periodic-purge.sh >> /var/log/cron.log 2>&1" > /etc
 ### Environment setup
 FROM base AS build
 
-COPY environment.yml .
-RUN conda env create
+COPY pixi.lock .
+COPY pyproject.toml .
+RUN pixi install --locked -e deploy
 
 WORKDIR /var/www/livedata
 COPY src app
@@ -28,4 +29,4 @@ FROM build AS final
 
 COPY deploy/django/docker-entrypoint.sh /usr/bin/
 RUN chmod +x /usr/bin/docker-entrypoint.sh
-ENTRYPOINT ["conda", "run", "--no-capture-output", "-n", "livedata", "/usr/bin/docker-entrypoint.sh"]
+ENTRYPOINT ["pixi", "run" , "-e", "deploy", "/usr/bin/docker-entrypoint.sh"]

docs/developer/config_for_local_use.rst

@@ -8,19 +8,19 @@ Prerequisites
 -------------
 - `Docker <https://docs.docker.com/get-docker/>`_
 - `Docker Compose <https://docs.docker.com/compose/install/>`_
-- `Conda <https://docs.conda.io/en/latest/miniconda.html>`_
+- `Pixi <https://pixi.sh>`_
 
 Setup
 -----
 
 Clone the repository and ``cd`` into the project directory.
 
-Create a conda environment ``livedata``, containing all the dependencies
+Create a pixi environment ``live_data_server``, containing all the dependencies
 
 .. code-block:: python
 
-  conda env create -f environment.yml
-  conda activate livedata
+  pixi install
+  pixi shell
 
 To deploy this application locally, you will need to set a number of environment variables,
 for example (bash):