From a82e5a6e290a0b93ca1be0d2d2d3877423b22edc Mon Sep 17 00:00:00 2001 From: David Erb Date: Sat, 4 Feb 2023 08:34:38 +0000 Subject: [PATCH] new devops --- .dae-devops/Makefile | 4 ++-- .dae-devops/docs/conventions.rst | 4 ++-- .dae-devops/docs/developing.rst | 6 +++--- .dae-devops/docs/devops.rst | 4 ++-- .dae-devops/docs/docs_structure.rst | 4 ++-- .dae-devops/docs/installing.rst | 10 +++++----- .dae-devops/docs/testing.rst | 4 ++-- .dae-devops/prepare_git_dependencies.sh | 4 ++-- .devcontainer/Dockerfile | 4 ++-- .devcontainer/devcontainer.json | 4 ++-- .github/CONTRIBUTING.rst | 4 ++-- .github/actions/install_requirements/action.yml | 4 ++-- .github/dependabot.yml | 4 ++-- .github/pages/index.html | 4 ++-- .github/pages/make_switcher.py | 4 ++-- .github/workflows/code.yml | 10 +++++----- .github/workflows/docs.yml | 6 +++--- .github/workflows/docs_clean.yml | 4 ++-- .github/workflows/linkcheck.yml | 4 ++-- .gitlab-ci.yml | 4 ++-- docs/_static/css/custom.css | 4 ++-- docs/conf.py | 6 +++--- pyproject.toml | 9 ++++----- 23 files changed, 57 insertions(+), 58 deletions(-) diff --git a/.dae-devops/Makefile b/.dae-devops/Makefile index f069420..46ab094 100644 --- a/.dae-devops/Makefile +++ b/.dae-devops/Makefile @@ -1,5 +1,5 @@ # ********** Please don't edit this file! -# ********** It has been generated automatically by dae_devops version 0.4.0. +# ********** It has been generated automatically by dae_devops version 0.5.1. # ********** For repository_name dls-servbase # --------------------------------------------------------------------- @@ -69,4 +69,4 @@ publish_docs: cp -r build/html/* $(DOCS_PUBLISH_ROOT) -# dae_devops_fingerprint 638cf348ec2f322b7b9f04d530307d75 +# dae_devops_fingerprint 7a23f38c29161947fccae923f8bbd305 diff --git a/.dae-devops/docs/conventions.rst b/.dae-devops/docs/conventions.rst index cbd716f..23f5c0d 100644 --- a/.dae-devops/docs/conventions.rst +++ b/.dae-devops/docs/conventions.rst @@ -1,5 +1,5 @@ .. # ********** Please don't edit this file! -.. # ********** It has been generated automatically by dae_devops version 0.4.0. +.. # ********** It has been generated automatically by dae_devops version 0.5.1. .. # ********** For repository_name dls-servbase Naming conventions @@ -31,4 +31,4 @@ repository lowercase, hyphens -.. # dae_devops_fingerprint bff58dcac6e3d129d307b9a3464e8196 +.. # dae_devops_fingerprint 5d19e046c051d4a16ee629f286bc2c19 diff --git a/.dae-devops/docs/developing.rst b/.dae-devops/docs/developing.rst index 1cbec57..9f2637d 100644 --- a/.dae-devops/docs/developing.rst +++ b/.dae-devops/docs/developing.rst @@ -1,5 +1,5 @@ .. # ********** Please don't edit this file! -.. # ********** It has been generated automatically by dae_devops version 0.4.0. +.. # ********** It has been generated automatically by dae_devops version 0.5.1. .. # ********** For repository_name dls-servbase Developing @@ -13,7 +13,7 @@ Clone the repository:: It is recommended that you install into a virtual environment so this installation will not interfere with any existing Python software. -Make sure to have at least python version 3.8 then:: +Make sure to have at least python version 3.9 then:: $ python3 -m venv /scratch/$USER/myvenv $ source /scratch/$USER/myvenv/bin/activate @@ -36,4 +36,4 @@ If you plan to modify the docs, you will need to:: -.. # dae_devops_fingerprint dac81ff2ba4786d22e83b5ec59976b56 +.. # dae_devops_fingerprint 5bc837feb8c9860f60d6c7306735b309 diff --git a/.dae-devops/docs/devops.rst b/.dae-devops/docs/devops.rst index 4b8ed22..fed6e4f 100644 --- a/.dae-devops/docs/devops.rst +++ b/.dae-devops/docs/devops.rst @@ -1,5 +1,5 @@ .. # ********** Please don't edit this file! -.. # ********** It has been generated automatically by dae_devops version 0.4.0. +.. # ********** It has been generated automatically by dae_devops version 0.5.1. .. # ********** For repository_name dls-servbase Devops @@ -43,4 +43,4 @@ Publishing:: -.. # dae_devops_fingerprint 63c64d09c7191f1f5a669e85521551b4 +.. # dae_devops_fingerprint 912adad2f71ce3835a8c9a38fe5d551b diff --git a/.dae-devops/docs/docs_structure.rst b/.dae-devops/docs/docs_structure.rst index bb5d8d2..8b5662a 100644 --- a/.dae-devops/docs/docs_structure.rst +++ b/.dae-devops/docs/docs_structure.rst @@ -1,5 +1,5 @@ .. # ********** Please don't edit this file! -.. # ********** It has been generated automatically by dae_devops version 0.4.0. +.. # ********** It has been generated automatically by dae_devops version 0.5.1. .. # ********** For repository_name dls-servbase About the documentation @@ -21,4 +21,4 @@ improve most documentation - often immensely. `More information on this topic. `_ -.. # dae_devops_fingerprint a62dd67d13a171d88dfa749e0b4040bd +.. # dae_devops_fingerprint 95b2af9e12a82868a16f5665963f9b36 diff --git a/.dae-devops/docs/installing.rst b/.dae-devops/docs/installing.rst index a1c9487..a427ac4 100644 --- a/.dae-devops/docs/installing.rst +++ b/.dae-devops/docs/installing.rst @@ -1,16 +1,16 @@ .. # ********** Please don't edit this file! -.. # ********** It has been generated automatically by dae_devops version 0.4.0. +.. # ********** It has been generated automatically by dae_devops version 0.5.1. .. # ********** For repository_name dls-servbase Installing ======================================================================= -You will need python 3.8 or later. +You will need python 3.9 or later. -On a Diamond Light Source internal computer, you can achieve Python 3.8 by:: +On a Diamond Light Source internal computer, you can achieve Python 3.9 by:: - $ module load python/3.8 + $ module load python/3.9 You can check your version of python by typing into a terminal:: @@ -40,4 +40,4 @@ You can check the version that has been installed by typing:: $ dls-servbase --version $ dls-servbase --version-json -.. # dae_devops_fingerprint ccb45053b6429ddaafb4e4e554dbe60c +.. # dae_devops_fingerprint 6452f6cf28bc217ba15f858859a68a81 diff --git a/.dae-devops/docs/testing.rst b/.dae-devops/docs/testing.rst index a803916..60d23a5 100644 --- a/.dae-devops/docs/testing.rst +++ b/.dae-devops/docs/testing.rst @@ -1,5 +1,5 @@ .. # ********** Please don't edit this file! -.. # ********** It has been generated automatically by dae_devops version 0.4.0. +.. # ********** It has been generated automatically by dae_devops version 0.5.1. .. # ********** For repository_name dls-servbase Testing @@ -35,4 +35,4 @@ This allows peeking in there to see what's been written by the test. -.. # dae_devops_fingerprint 65edd9eb8fdb9ce254e25f52b7826865 +.. # dae_devops_fingerprint a81ed6819b23588ae73eb051b3376972 diff --git a/.dae-devops/prepare_git_dependencies.sh b/.dae-devops/prepare_git_dependencies.sh index cdeaa3e..53c65ee 100644 --- a/.dae-devops/prepare_git_dependencies.sh +++ b/.dae-devops/prepare_git_dependencies.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash # ********** Please don't edit this file! -# ********** It has been generated automatically by dae_devops version 0.4.0. +# ********** It has been generated automatically by dae_devops version 0.5.1. # ********** For repository_name dls-servbase me=${BASH_SOURCE} @@ -13,4 +13,4 @@ function __install { } -# dae_devops_fingerprint 11605b8e3fd3f9d8a328f7e506c3a8df \ No newline at end of file +# dae_devops_fingerprint 6dc74e6d6532cc737064726a8e84ec06 \ No newline at end of file diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index e9b0581..ba9e687 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # ********** Please don't edit this file! -# ********** It has been generated automatically by dae_devops version 0.4.0. +# ********** It has been generated automatically by dae_devops version 0.5.1. # ********** For repository_name dls-servbase # This file is for use as a devcontainer and a runtime container @@ -40,4 +40,4 @@ ENV PATH=/venv/bin:$PATH ENTRYPOINT ["dls-servbase"] CMD ["--version"] -# dae_devops_fingerprint 0ed4c108c50d3e0396850c46b6cc87a5 +# dae_devops_fingerprint 72790a37eb1b5b840c0d00d66686e29c diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 40d0035..a005dee 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -1,5 +1,5 @@ // ********** Please don't edit this file! -// ********** It has been generated automatically by dae_devops version 0.4.0. +// ********** It has been generated automatically by dae_devops version 0.5.1. // ********** For repository_name dls-servbase // For format details, see https://containers.dev/implementors/json_reference/ @@ -57,4 +57,4 @@ "postCreateCommand": "pip install -e .[dev]" } -// dae_devops_fingerprint 9f538222c362bf19d30666af4a11649c +// dae_devops_fingerprint c480df13e60f0ff3f2dfa9b9aa2b328a diff --git a/.github/CONTRIBUTING.rst b/.github/CONTRIBUTING.rst index e2e7e2f..a0c6635 100644 --- a/.github/CONTRIBUTING.rst +++ b/.github/CONTRIBUTING.rst @@ -1,5 +1,5 @@ .. # ********** Please don't edit this file! -.. # ********** It has been generated automatically by dae_devops version 0.4.0. +.. # ********** It has been generated automatically by dae_devops version 0.5.1. .. # ********** For repository_name dls-servbase Contributing to the project @@ -38,4 +38,4 @@ should follow. .. _Developer Guide: https://diamondlightsource.github.io/dls-servbase/main/developer/how-to/contribute.html -.. # dae_devops_fingerprint 16efe24197ed9ea8fcec3952d5b2b1be +.. # dae_devops_fingerprint c992909872721c6ed1baa7850bda0d5e diff --git a/.github/actions/install_requirements/action.yml b/.github/actions/install_requirements/action.yml index 9b2da8c..889703b 100644 --- a/.github/actions/install_requirements/action.yml +++ b/.github/actions/install_requirements/action.yml @@ -1,5 +1,5 @@ # ********** Please don't edit this file! -# ********** It has been generated automatically by dae_devops version 0.4.0. +# ********** It has been generated automatically by dae_devops version 0.5.1. # ********** For repository_name dls-servbase name: Install requirements @@ -61,4 +61,4 @@ runs: shell: bash -# dae_devops_fingerprint a943ecda0d87aab864c56b56de180896 +# dae_devops_fingerprint 0e8a156e6135b4de56611be7bbcb9a63 diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 87262f4..a48dedf 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -1,5 +1,5 @@ # ********** Please don't edit this file! -# ********** It has been generated automatically by dae_devops version 0.4.0. +# ********** It has been generated automatically by dae_devops version 0.5.1. # ********** For repository_name dls-servbase # To get started with Dependabot version updates, you'll need to specify which @@ -19,4 +19,4 @@ updates: schedule: interval: "weekly" -# dae_devops_fingerprint 926514fe051a2d754ad2592cd1bf730d +# dae_devops_fingerprint 1ecb90130c44325909efc5d1f0dfeb7a diff --git a/.github/pages/index.html b/.github/pages/index.html index 4e4fbd5..00b4353 100644 --- a/.github/pages/index.html +++ b/.github/pages/index.html @@ -1,5 +1,5 @@ - + @@ -14,4 +14,4 @@ - + diff --git a/.github/pages/make_switcher.py b/.github/pages/make_switcher.py index 1a5ee61..0c5eb10 100644 --- a/.github/pages/make_switcher.py +++ b/.github/pages/make_switcher.py @@ -1,5 +1,5 @@ # ********** Please don't edit this file! -# ********** It has been generated automatically by dae_devops version 0.4.0. +# ********** It has been generated automatically by dae_devops version 0.5.1. # ********** For repository_name dls-servbase import json @@ -102,4 +102,4 @@ def main(args=None): if __name__ == "__main__": main() -# dae_devops_fingerprint 4516495efe91a5543b67e38cbdc50fcb +# dae_devops_fingerprint d45ac4442f007d5c202322023d7eb65d diff --git a/.github/workflows/code.yml b/.github/workflows/code.yml index 1cada0c..50ce414 100644 --- a/.github/workflows/code.yml +++ b/.github/workflows/code.yml @@ -1,5 +1,5 @@ # ********** Please don't edit this file! -# ********** It has been generated automatically by dae_devops version 0.4.0. +# ********** It has been generated automatically by dae_devops version 0.5.1. # ********** For repository_name dls-servbase name: Code CI @@ -39,12 +39,12 @@ jobs: fail-fast: false matrix: os: ["ubuntu-latest"] # can add windows-latest, macos-latest - python: ["3.9", "3.10", "3.11"] + python: ["3.10", "3.11"] install: ["-e .[dev,docs]"] # Make one version be non-editable to test both paths of version code include: - os: "ubuntu-latest" - python: "3.8" + python: "3.9" install: ".[dev,docs]" runs-on: ${{ matrix.os }} @@ -196,7 +196,7 @@ jobs: - name: Github Release # We pin to the SHA, not the tag, for security reasons. # https://docs.github.com/en/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions - uses: softprops/action-gh-release@1e07f4398721186383de40550babbdf2b84acfc5 # v0.1.14 + uses: softprops/action-gh-release@de2c0eb89ae2a093876385947365aca7b0e5f844 # v0.1.15 with: prerelease: ${{ contains(github.ref_name, 'a') || contains(github.ref_name, 'b') || contains(github.ref_name, 'rc') }} files: | @@ -212,4 +212,4 @@ jobs: with: password: ${{ secrets.PYPI_TOKEN }} -# dae_devops_fingerprint 61d65b39296510a71243b277e3ecc013 +# dae_devops_fingerprint 46a9b33922765482ba5494cce33f1036 diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index c0e0fec..feb1447 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -1,5 +1,5 @@ # ********** Please don't edit this file! -# ********** It has been generated automatically by dae_devops version 0.4.0. +# ********** It has been generated automatically by dae_devops version 0.5.1. # ********** For repository_name dls-servbase name: Docs CI @@ -50,10 +50,10 @@ jobs: if: github.event_name == 'push' && github.actor != 'dependabot[bot]' # We pin to the SHA, not the tag, for security reasons. # https://docs.github.com/en/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions - uses: peaceiris/actions-gh-pages@de7ea6f8efb354206b205ef54722213d99067935 # v3.9.0 + uses: peaceiris/actions-gh-pages@bd8c6b06eba6b3d25d72b7a1767993c0aeee42e7 # v3.9.2 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: .github/pages keep_files: true -# dae_devops_fingerprint a563edc9403ab4df4f258a92ad0e1fd8 +# dae_devops_fingerprint 3affc4caa616b260ff6f508827744c34 diff --git a/.github/workflows/docs_clean.yml b/.github/workflows/docs_clean.yml index 5d59e2e..f1f3c2a 100644 --- a/.github/workflows/docs_clean.yml +++ b/.github/workflows/docs_clean.yml @@ -1,5 +1,5 @@ # ********** Please don't edit this file! -# ********** It has been generated automatically by dae_devops version 0.4.0. +# ********** It has been generated automatically by dae_devops version 0.5.1. # ********** For repository_name dls-servbase name: Docs Cleanup CI @@ -46,4 +46,4 @@ jobs: git commit -am "Removing redundant docs version $DOCS_VERSION" git push -# dae_devops_fingerprint 84b9fae350cdfe475f580b0db209da97 +# dae_devops_fingerprint 68ce5fae72353989a1554059196d42da diff --git a/.github/workflows/linkcheck.yml b/.github/workflows/linkcheck.yml index e2666f3..ab53679 100644 --- a/.github/workflows/linkcheck.yml +++ b/.github/workflows/linkcheck.yml @@ -1,5 +1,5 @@ # ********** Please don't edit this file! -# ********** It has been generated automatically by dae_devops version 0.4.0. +# ********** It has been generated automatically by dae_devops version 0.5.1. # ********** For repository_name dls-servbase name: Link Check @@ -27,4 +27,4 @@ jobs: - name: Check links run: tox -e docs build -- -b linkcheck -# dae_devops_fingerprint c37f3d1c74d0f500428da2ea21226302 +# dae_devops_fingerprint a55267064a520cd8be7af6d4c55ee0b8 diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 56bc3fa..0f9d6ca 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,5 +1,5 @@ # ********** Please don't edit this file! -# ********** It has been generated automatically by dae_devops version 0.4.0. +# ********** It has been generated automatically by dae_devops version 0.5.1. # ********** For repository_name dls-servbase variables: @@ -87,4 +87,4 @@ package_pip: # # The validate_docs artifacts are in the build/html folder. # - make -f .dae-devops/Makefile publish_docs -# dae_devops_fingerprint 4820040f4423d245a9453d12e92e9fb0 +# dae_devops_fingerprint 8867b36d7cb9bddfb82408ec9bcc7a77 diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css index 171e9e9..7a8e156 100644 --- a/docs/_static/css/custom.css +++ b/docs/_static/css/custom.css @@ -1,5 +1,5 @@ /* ********** Please don't edit this file! */ -/* ********** It has been generated automatically by dae_devops version 0.4.0. */ +/* ********** It has been generated automatically by dae_devops version 0.5.1. */ /* ********** For repository_name dls-servbase */ /* The theme normally has this, but I think it's ok to use the full width of the window in all @media sizes. @@ -15,4 +15,4 @@ max-width: 100%; } -/* dae_devops_fingerprint ccfab80a5e011ff8ab45d6656a3317b4 */ +/* dae_devops_fingerprint e90995272484f14054d768f27cdba7dc */ diff --git a/docs/conf.py b/docs/conf.py index 59aa996..6bd5a73 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,5 +1,5 @@ # ********** Please don't edit this file! -# ********** It has been generated automatically by dae_devops version 0.4.0. +# ********** It has been generated automatically by dae_devops version 0.5.1. # ********** For repository_name dls-servbase from pathlib import Path @@ -188,7 +188,7 @@ def ultimateReplace(app, docname, source): "$" + "{repository_name}": "dls-servbase", "$" + "{package_name}": "dls_servbase_lib", "$" + "{git_url}": "https://gitlab.diamond.ac.uk/kbp43231", - "$" + "{python_version_at_least}": "3.8", + "$" + "{python_version_at_least}": "3.9", } @@ -197,4 +197,4 @@ def setup(app): app.connect("source-read", ultimateReplace) -# dae_devops_fingerprint e982958c40cc93952bbb78c601bcfd20 +# dae_devops_fingerprint 389ff630a4932067e15b261055392e20 diff --git a/pyproject.toml b/pyproject.toml index 7fcd49f..38bfc45 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,5 +1,5 @@ # ********** Please don't edit this file! -# ********** It has been generated automatically by dae_devops version 0.4.0. +# ********** It has been generated automatically by dae_devops version 0.5.1. # ********** For repository_name dls-servbase [build-system] @@ -11,7 +11,6 @@ name = "dls-servbase" classifiers = [ "Development Status :: 3 - Alpha", "License :: OSI Approved :: Apache Software License", - "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", @@ -21,11 +20,11 @@ dependencies = ["aiohttp==3.8.3", "dls_mainiac", "dls_normsql", "setproctitle"] dynamic = ["version"] license.file = "LICENSE" readme = "README.rst" -requires-python = ">=3.8" +requires-python = ">=3.9" [project.optional-dependencies] dev = [ - "black", + "black==22.12.0", "mypy", "flake8-isort", "Flake8-pyproject", @@ -102,4 +101,4 @@ source = ["src", "**/site-packages/"] [tool.tox] legacy_tox_ini = "[tox]\nskipsdist=True\n\n[testenv:{pre-commit,mypy,pytest,docs}]\n# Don't create a virtualenv for the command, requires tox-direct plugin\ndirect = True\npassenv = *\nallowlist_externals = \n pytest \n pre-commit\n mypy\n sphinx-build\n sphinx-autobuild\ncommands =\n pytest: pytest {posargs}\n mypy: mypy src tests {posargs}\n pre-commit: pre-commit run --all-files {posargs}\n docs: sphinx-{posargs:build -EW --keep-going} -T docs build/html\n" -# dae_devops_fingerprint 891506e71a08819713206219442a9fc0 +# dae_devops_fingerprint 610a6bbccf41d8c2fa60131e7e88be57