Merge pull request #71 from scipp/unpinned-nightly

Copier update
scipp · Nov 9, 2023 · 1b2827e · 1b2827e
2 parents 1e7aad4 + 438a790
commit 1b2827e
Show file tree

Hide file tree

Showing 20 changed files with 179 additions and 57 deletions.
diff --git a/.copier-answers.yml b/.copier-answers.yml
@@ -1,9 +1,10 @@
 # Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
-_commit: 31bdf85
+_commit: 710e613
 _src_path: gh:scipp/copier_template
 description: Build scientific pipelines for your data
 max_python: '3.12'
 min_python: '3.8'
+namespace_package: ''
 nightly_deps: ''
 orgname: scipp
 projectname: sciline

diff --git a/.github/workflows/nightly.yml → .github/workflows/nightly_at_main.yml b/.github/workflows/nightly.yml → .github/workflows/nightly_at_main.yml
@@ -1,12 +1,12 @@
 # SPDX-License-Identifier: BSD-3-Clause
 # Copyright (c) 2023 Scipp contributors (https://github.com/scipp)
 
-name: Nightly CI
+name: Nightly test at main branch
 
 on:
   workflow_dispatch:
   schedule:
-    - cron: '0 0 * * *'
+    - cron: '30 1 * * 1-5'
 
 jobs:
   setup:

diff --git a/.github/workflows/nightly_at_release.yml b/.github/workflows/nightly_at_release.yml
@@ -0,0 +1,43 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright (c) 2023 Scipp contributors (https://github.com/scipp)
+
+name: Nightly tests at latest release
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 1 * * 1-5'
+
+jobs:
+  setup:
+    name: Setup variables
+    runs-on: 'ubuntu-20.04'
+    outputs:
+      min_python: ${{ steps.vars.outputs.min_python }}
+      release_tag: ${{ steps.release.outputs.release_tag }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # history required so we can determine latest release tag
+      - name: Get last release tag from git
+        id: release
+        run: echo "release_tag=$(git describe --tags --abbrev=0 --match '[0-9]*.[0-9]*.[0-9]*')" >> $GITHUB_OUTPUT
+      - name: Get Python version for other CI jobs
+        id: vars
+        run: echo "min_python=$(cat .github/workflows/python-version-ci)" >> $GITHUB_OUTPUT
+
+  tests:
+    name: Tests
+    needs: setup
+    strategy:
+      matrix:
+        os: ['ubuntu-20.04']
+        python:
+          - version: '${{needs.setup.outputs.min_python}}'
+            tox-env: 'nightly'
+    uses: ./.github/workflows/test.yml
+    with:
+      os-variant: ${{ matrix.os }}
+      python-version: ${{ matrix.python.version }}
+      tox-env: ${{ matrix.python.tox-env }}
+      checkout_ref: ${{ needs.setup.outputs.release_tag }}
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -21,7 +21,7 @@ jobs:
       - uses: actions/checkout@v3
         with:
           submodules: true
-          fetch-depth: 0  # history required so cmake can determine version
+          fetch-depth: 0  # history required so setuptools_scm can determine version
 
       - uses: mamba-org/setup-micromamba@v1
         with:
@@ -84,8 +84,10 @@ jobs:
       - uses: mamba-org/setup-micromamba@v1
         with:
           environment-name: upload-env
+          # frozen python due to breaking removal of 'imp' in 3.12
           create-args: >-
             anaconda-client
+            python=3.11
       - run: anaconda --token ${{ secrets.ANACONDATOKEN }} upload --user scipp --label main $(ls conda-package-noarch/*.tar.bz2)
 
   docs:

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -20,6 +20,9 @@ on:
       coverage-report:
         default: false
         type: boolean
+      checkout_ref:
+        default: ''
+        type: string
   workflow_call:
     inputs:
       os-variant:
@@ -36,13 +39,18 @@ on:
       coverage-report:
         default: false
         type: boolean
+      checkout_ref:
+        default: ''
+        type: string
 
 jobs:
   test:
     runs-on: ${{ inputs.os-variant }}
 
     steps:
       - uses: actions/checkout@v3
+        with:
+          ref: ${{ inputs.checkout_ref }}
       - uses: actions/setup-python@v3
         with:
           python-version: ${{ inputs.python-version }}

diff --git a/.github/workflows/unpinned.yml b/.github/workflows/unpinned.yml
@@ -0,0 +1,43 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright (c) 2023 Scipp contributors (https://github.com/scipp)
+
+name: Unpinned tests at latest release
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 2 * * 1'
+
+jobs:
+  setup:
+    name: Setup variables
+    runs-on: 'ubuntu-20.04'
+    outputs:
+      min_python: ${{ steps.vars.outputs.min_python }}
+      release_tag: ${{ steps.release.outputs.release_tag }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # history required so we can determine latest release tag
+      - name: Get last release tag from git
+        id: release
+        run: echo "release_tag=$(git describe --tags --abbrev=0 --match '[0-9]*.[0-9]*.[0-9]*')" >> $GITHUB_OUTPUT
+      - name: Get Python version for other CI jobs
+        id: vars
+        run: echo "min_python=$(cat .github/workflows/python-version-ci)" >> $GITHUB_OUTPUT
+
+  tests:
+    name: Tests
+    needs: setup
+    strategy:
+      matrix:
+        os: ['ubuntu-20.04']
+        python:
+          - version: '${{needs.setup.outputs.min_python}}'
+            tox-env: 'unpinned'
+    uses: ./.github/workflows/test.yml
+    with:
+      os-variant: ${{ matrix.os }}
+      python-version: ${{ matrix.python.version }}
+      tox-env: ${{ matrix.python.tox-env }}
+      checkout_ref: ${{ needs.setup.outputs.release_tag }}
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -61,7 +61,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-scipp@ess.eu.
+scipp[at]ess.eu.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

diff --git a/docs/about/index.md b/docs/about/index.md
@@ -8,6 +8,14 @@ Sciline is an open source project by the [European Spallation Source ERIC](https
 
 Sciline is available as open source under the [BSD-3 license](https://opensource.org/licenses/BSD-3-Clause).
 
+## Citing Sciline
+
+Please cite the following:
+
+[![DOI](https://zenodo.org/badge/FIXME.svg)](https://zenodo.org/doi/10.5281/zenodo.FIXME)
+
+To cite a specific version of Sciline, select the desired version on Zenodo to get the corresponding DOI.
+
 ## Older versions of the documentation
 
 Older versions of the documentation pages can be found under the assets of each [release](https://github.com/scipp/sciline/releases).

diff --git a/docs/developer/getting-started.md b/docs/developer/getting-started.md
@@ -78,14 +78,14 @@ tox -e linkcheck
 Build the documentation using
 
 ```sh
-python -m sphinx -v -b html -d build/.doctrees docs build/html
+python -m sphinx -v -b html -d .tox/docs_doctrees docs html
 ```
 
 Additionally, test the documentation using
 
 ```sh
-python -m sphinx -v -b doctest -d build/.doctrees docs build/html
-python -m sphinx -v -b linkcheck -d build/.doctrees docs build/html
+python -m sphinx -v -b doctest -d .tox/docs_doctrees docs html
+python -m sphinx -v -b linkcheck -d .tox/docs_doctrees docs html
 ```
 ````
 `````
diff --git a/pyproject.toml b/pyproject.toml
@@ -39,6 +39,7 @@ dynamic = ["version"]
 
 [project.urls]
 "Bug Tracker" = "https://github.com/scipp/sciline/issues"
+"Documentation" = "https://scipp.github.io/sciline"
 "Source" = "https://github.com/scipp/sciline"
 
 [tool.setuptools_scm]
@@ -61,6 +62,7 @@ skip-string-normalization = true
 [tool.isort]
 skip_gitignore = true
 profile = "black"
+known_first_party = ["sciline"]
 
 [tool.mypy]
 strict = true

diff --git a/requirements/base.in b/requirements/base.in
@@ -1,2 +1,2 @@
 # Generated by 'tox -e deps', DO NOT EDIT MANUALLY!'
-graphlib-backport
+graphlib-backport
diff --git a/requirements/ci.txt b/requirements/ci.txt
@@ -5,23 +5,23 @@
 #
 #    pip-compile-multi
 #
-cachetools==5.3.1
+cachetools==5.3.2
     # via tox
 certifi==2023.7.22
     # via requests
 chardet==5.2.0
     # via tox
-charset-normalizer==3.3.0
+charset-normalizer==3.3.2
     # via requests
 colorama==0.4.6
     # via tox
 distlib==0.3.7
     # via virtualenv
-filelock==3.12.4
+filelock==3.13.1
     # via
     #   tox
     #   virtualenv
-gitdb==4.0.10
+gitdb==4.0.11
     # via gitpython
 gitpython==3.1.40
     # via -r ci.in
@@ -52,5 +52,5 @@ tox==4.11.3
     # via -r ci.in
 urllib3==2.0.7
     # via requests
-virtualenv==20.24.5
+virtualenv==20.24.6
     # via tox
diff --git a/requirements/dev.txt b/requirements/dev.txt
@@ -36,26 +36,26 @@ json5==0.9.14
     # via jupyterlab-server
 jsonpointer==2.4
     # via jsonschema
-jsonschema[format-nongpl]==4.19.1
+jsonschema[format-nongpl]==4.19.2
     # via
     #   jupyter-events
     #   jupyterlab-server
     #   nbformat
-jupyter-events==0.8.0
+jupyter-events==0.9.0
     # via jupyter-server
 jupyter-lsp==2.2.0
     # via jupyterlab
-jupyter-server==2.8.0
+jupyter-server==2.10.0
     # via
     #   jupyter-lsp
     #   jupyterlab
     #   jupyterlab-server
     #   notebook-shim
 jupyter-server-terminals==0.4.4
     # via jupyter-server
-jupyterlab==4.0.7
+jupyterlab==4.0.8
     # via -r dev.in
-jupyterlab-server==2.25.0
+jupyterlab-server==2.25.1
     # via jupyterlab
 notebook-shim==0.2.3
     # via jupyterlab
@@ -65,7 +65,7 @@ pip-compile-multi==2.6.3
     # via -r dev.in
 pip-tools==7.3.0
     # via pip-compile-multi
-prometheus-client==0.17.1
+prometheus-client==0.18.0
     # via jupyter-server
 pycparser==2.21
     # via cffi
@@ -97,7 +97,7 @@ webcolors==1.13
     # via jsonschema
 websocket-client==1.6.4
     # via jupyter-server
-wheel==0.41.2
+wheel==0.41.3
     # via pip-tools
 
 # The following packages are considered to be unsafe in a requirements file: