diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 7e1c7eee..4a51f371 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,10 +1,19 @@ -# This PR is related to user story DST-XXX + +### This PR is related to user story [ESS-XXXX](url_to_jira_task) ## Description Provide a short description about the work that has been done. ## Checklist -- [ ] All COS are met. -- [ ] All integration tests pass (if applicable). -- [ ] New functions, methods and classes are added to the documentation. -- [ ] New functions, methods and classes are tested (hint: check coverage report). +- [ ] PR title is descriptive and fit for injection into release notes (see tips below) +- [ ] Correct label(s) are used + + +PR title tips: +* Use imperative mood +* Describe the motivation for change, issue that has been solved or what has been improved - not how +* Examples: + * Add functionality for Allan variance to sensor_4s.simulate + * Upgrade to support Python 9.10 + * Remove MacOS from CI + diff --git a/.github/workflows/deploy_public.yml b/.github/workflows/deploy_public.yml index a590970f..336883fd 100644 --- a/.github/workflows/deploy_public.yml +++ b/.github/workflows/deploy_public.yml @@ -43,8 +43,7 @@ jobs: - name: Install dependencies run: | python -m pip install --upgrade pip - python -m pip install build sphinx==5.3.0 pydata_sphinx_theme==0.11.0 - python -m pip install --upgrade myst_parser + python -m pip install build sphinx==5.3.0 pydata_sphinx_theme==0.11.0 myst_parser - name: Get new version number from input id: version_number diff --git a/tox-deploy.ini b/tox-deploy.ini index f94faade..1a257135 100644 --- a/tox-deploy.ini +++ b/tox-deploy.ini @@ -1,19 +1,12 @@ -# tox (https://tox.readthedocs.io/) is a tool for running tests -# in multiple virtualenvs. This configuration file will run the -# test suite on all supported python versions. To use it, "pip install tox" -# and then run "tox" from this directory. - [tox] +isolated_build = True envlist = py39 [testenv] -install_command = pip install {opts} {packages} deps = - setuptools - sphinx - sphinx_bootstrap_theme -whitelist_externals = - setup.py + build + sphinx==5.3.0 + pydata_sphinx_theme==0.11.0 commands = - setup.py bdist_wheel --dist-dir ./build - setup.py build_sphinx --build-dir ./build + python -m build --outdir ./build + sphinx-build -b html ./docs ./build/html \ No newline at end of file diff --git a/tox.ini b/tox.ini index 2e546703..fe4e1b79 100644 --- a/tox.ini +++ b/tox.ini @@ -17,4 +17,4 @@ commands = sphinx-build -W -b html -d {toxworkdir}/docs_doctree docs {toxworkdir deps = sphinx == 5.3.0 pydata-sphinx-theme == 0.11.0 - myst_parser \ No newline at end of file + myst_parser < 2.0 \ No newline at end of file