Skip to content

Commit

Permalink
lint and devops
Browse files Browse the repository at this point in the history
  • Loading branch information
David Erb committed Apr 8, 2023
1 parent d2ccb14 commit 1189a5f
Show file tree
Hide file tree
Showing 24 changed files with 60 additions and 59 deletions.
4 changes: 2 additions & 2 deletions .dae-devops/Makefile
Original file line number Diff line number Diff line change
@@ -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.2.
# ********** For repository_name dls-normsql

# ---------------------------------------------------------------------
Expand Down Expand Up @@ -69,4 +69,4 @@ publish_docs:
cp -r build/html/* $(DOCS_PUBLISH_ROOT)


# dae_devops_fingerprint 9a5dedf3d519c11e1d36b87095ed4f26
# dae_devops_fingerprint 3f13d455c444ad39930aabfc68547c2c
4 changes: 2 additions & 2 deletions .dae-devops/docs/conventions.rst
Original file line number Diff line number Diff line change
@@ -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.2.
.. # ********** For repository_name dls-normsql
Naming conventions
Expand Down Expand Up @@ -31,4 +31,4 @@ repository
lowercase, hyphens


.. # dae_devops_fingerprint febbfa9d192af5010a4cd5e6de836097
.. # dae_devops_fingerprint 81e582297295ea8d1145aeb4fb60ffef
6 changes: 3 additions & 3 deletions .dae-devops/docs/developing.rst
Original file line number Diff line number Diff line change
@@ -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.2.
.. # ********** For repository_name dls-normsql
Developing
Expand All @@ -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
Expand All @@ -36,4 +36,4 @@ If you plan to modify the docs, you will need to::


.. # dae_devops_fingerprint 07f1e374bc286bfd64edca93fbfbec4b
.. # dae_devops_fingerprint 550d6069746935ee4e08d958dd046fa2
4 changes: 2 additions & 2 deletions .dae-devops/docs/devops.rst
Original file line number Diff line number Diff line change
@@ -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.2.
.. # ********** For repository_name dls-normsql
Devops
Expand Down Expand Up @@ -43,4 +43,4 @@ Publishing::


.. # dae_devops_fingerprint 231c4947e546d9e98de707b418797c3b
.. # dae_devops_fingerprint 35ea37a143cb4560425194afc2bad8ed
4 changes: 2 additions & 2 deletions .dae-devops/docs/docs_structure.rst
Original file line number Diff line number Diff line change
@@ -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.2.
.. # ********** For repository_name dls-normsql
About the documentation
Expand All @@ -21,4 +21,4 @@ improve most documentation - often immensely.

`More information on this topic. <https://documentation.divio.com>`_

.. # dae_devops_fingerprint d70cbde1ea928b73721419cf1895f056
.. # dae_devops_fingerprint 68095839584c6e3455c1bd06350312f4
10 changes: 5 additions & 5 deletions .dae-devops/docs/installing.rst
Original file line number Diff line number Diff line change
@@ -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.2.
.. # ********** For repository_name dls-normsql
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::

Expand Down Expand Up @@ -40,4 +40,4 @@ You can check the version that has been installed by typing::
$ dls-normsql --version
$ dls-normsql --version-json

.. # dae_devops_fingerprint 99cdabc51a937f9f403b533ea3108c3f
.. # dae_devops_fingerprint f0f3fa3bcf53a551add4ee39538eb44a
4 changes: 2 additions & 2 deletions .dae-devops/docs/testing.rst
Original file line number Diff line number Diff line change
@@ -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.2.
.. # ********** For repository_name dls-normsql
Testing
Expand Down Expand Up @@ -35,4 +35,4 @@ This allows peeking in there to see what's been written by the test.



.. # dae_devops_fingerprint 32ce52a513e208dea899cdb3a378290c
.. # dae_devops_fingerprint 16abfa1d4f582c07e1ea9281771b8f4f
4 changes: 2 additions & 2 deletions .dae-devops/prepare_git_dependencies.sh
Original file line number Diff line number Diff line change
@@ -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.2.
# ********** For repository_name dls-normsql

me=${BASH_SOURCE}
Expand All @@ -13,4 +13,4 @@ function __install {
}


# dae_devops_fingerprint 93e61fd4bac57573417cfd42bb395e85
# dae_devops_fingerprint d2a7e27cfad2e9f2547dc2b0da58fdd1
4 changes: 2 additions & 2 deletions .devcontainer/Dockerfile
Original file line number Diff line number Diff line change
@@ -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.2.
# ********** For repository_name dls-normsql

# This file is for use as a devcontainer and a runtime container
Expand Down Expand Up @@ -40,4 +40,4 @@ ENV PATH=/venv/bin:$PATH
ENTRYPOINT ["dls-normsql"]
CMD ["--version"]

# dae_devops_fingerprint 37bdb2cf713e74e37b952b4e8895c779
# dae_devops_fingerprint 41ae7527130d2727aa06cd91ff8e5702
4 changes: 2 additions & 2 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -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.2.
// ********** For repository_name dls-normsql

// For format details, see https://containers.dev/implementors/json_reference/
Expand Down Expand Up @@ -57,4 +57,4 @@
"postCreateCommand": "pip install -e .[dev]"
}

// dae_devops_fingerprint 4fa020c7e129da97652ad6681386dfb4
// dae_devops_fingerprint bf6676a0739eeb0e671f3518d7739877
4 changes: 2 additions & 2 deletions .github/CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -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.2.
.. # ********** For repository_name dls-normsql
Contributing to the project
Expand Down Expand Up @@ -38,4 +38,4 @@ should follow.

.. _Developer Guide: https://diamondlightsource.github.io/dls-normsql/main/developer/how-to/contribute.html

.. # dae_devops_fingerprint 2e148c8136906d7b360a0a585c8b44b6
.. # dae_devops_fingerprint e4fc983b36dd78a7c7fefcb6ac9fdd13
4 changes: 2 additions & 2 deletions .github/actions/install_requirements/action.yml
Original file line number Diff line number Diff line change
@@ -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.2.
# ********** For repository_name dls-normsql

name: Install requirements
Expand Down Expand Up @@ -61,4 +61,4 @@ runs:
shell: bash


# dae_devops_fingerprint 403b45c3d93196f440b361f82fd19d44
# dae_devops_fingerprint 8d7ad9a9e4bbb3b504abc3a0f33579ee
4 changes: 2 additions & 2 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -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.2.
# ********** For repository_name dls-normsql

# To get started with Dependabot version updates, you'll need to specify which
Expand All @@ -19,4 +19,4 @@ updates:
schedule:
interval: "weekly"

# dae_devops_fingerprint 6ee2ea0888a0c28221efc18a81a6ab95
# dae_devops_fingerprint b8759630d6502121150bac83a60ac05d
4 changes: 2 additions & 2 deletions .github/pages/index.html
Original file line number Diff line number Diff line change
@@ -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.2. -->
<!-- ********** For repository_name dls-normsql -->

<!DOCTYPE html>
Expand All @@ -14,4 +14,4 @@

</html>

<!-- dae_devops_fingerprint 0d2ff9be44ac22445074f3d6d32cf1c1 -->
<!-- dae_devops_fingerprint d1650ec0d6d7791f6b665a22c9b8c4ff -->
4 changes: 2 additions & 2 deletions .github/pages/make_switcher.py
Original file line number Diff line number Diff line change
@@ -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.2.
# ********** For repository_name dls-normsql

import json
Expand Down Expand Up @@ -102,4 +102,4 @@ def main(args=None):
if __name__ == "__main__":
main()

# dae_devops_fingerprint 98ed975251d2ba05337bc8f1be89db19
# dae_devops_fingerprint 321882bf975a37cedc9e7def02e120fa
12 changes: 6 additions & 6 deletions .github/workflows/code.yml
Original file line number Diff line number Diff line change
@@ -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.2.
# ********** For repository_name dls-normsql

name: Code CI
Expand Down Expand Up @@ -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 }}
Expand Down Expand Up @@ -116,7 +116,7 @@ jobs:

- name: Test module --version works using the installed wheel
# If more than one module in src/ replace with module name to test
run: python -m $(ls src | grep -v egg-info | head -1) --version
run: dls-normsql --version-json

container:
needs: [lint, dist, test]
Expand Down Expand Up @@ -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: |
Expand All @@ -212,4 +212,4 @@ jobs:
with:
password: ${{ secrets.PYPI_TOKEN }}

# dae_devops_fingerprint cf8d5225c11d3034b152f9a336a424b5
# dae_devops_fingerprint 0eca35d77828ef5ba3c51d0d68628f12
6 changes: 3 additions & 3 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -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.2.
# ********** For repository_name dls-normsql

name: Docs CI
Expand Down Expand Up @@ -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 7c0880b71a26d9acc23bebb544f29fe8
# dae_devops_fingerprint ea6935f4eb0060233fc35dcccd2a0a36
4 changes: 2 additions & 2 deletions .github/workflows/docs_clean.yml
Original file line number Diff line number Diff line change
@@ -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.2.
# ********** For repository_name dls-normsql

name: Docs Cleanup CI
Expand Down Expand Up @@ -46,4 +46,4 @@ jobs:
git commit -am "Removing redundant docs version $DOCS_VERSION"
git push
# dae_devops_fingerprint d5c63c25908a991f0f9facd9329e636c
# dae_devops_fingerprint 53d885e9033e0abb28bcc63d8252ca03
4 changes: 2 additions & 2 deletions .github/workflows/linkcheck.yml
Original file line number Diff line number Diff line change
@@ -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.2.
# ********** For repository_name dls-normsql

name: Link Check
Expand Down Expand Up @@ -27,4 +27,4 @@ jobs:
- name: Check links
run: tox -e docs build -- -b linkcheck

# dae_devops_fingerprint cba7dec0be1268512cdb353265ad3062
# dae_devops_fingerprint f31df44c662aa0a356bb2a62fe64eade
4 changes: 2 additions & 2 deletions .gitlab-ci.yml
Original file line number Diff line number Diff line change
@@ -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.2.
# ********** For repository_name dls-normsql

variables:
Expand Down Expand Up @@ -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 4e9136dd730528488f4a163b52347f5e
# dae_devops_fingerprint 19ac89e7287f70ae7f5f96292102fde8
4 changes: 2 additions & 2 deletions docs/_static/css/custom.css
Original file line number Diff line number Diff line change
@@ -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.2. */
/* ********** For repository_name dls-normsql */

/* The theme normally has this, but I think it's ok to use the full width of the window in all @media sizes.
Expand All @@ -15,4 +15,4 @@
max-width: 100%;
}

/* dae_devops_fingerprint 76719c01b81e764bd515b95cfa4db1ad */
/* dae_devops_fingerprint b13b064702739049faa6ce9119be9039 */
6 changes: 3 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -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.2.
# ********** For repository_name dls-normsql

from pathlib import Path
Expand Down Expand Up @@ -188,7 +188,7 @@ def ultimateReplace(app, docname, source):
"$" + "{repository_name}": "dls-normsql",
"$" + "{package_name}": "dls_normsql",
"$" + "{git_url}": "https://gitlab.diamond.ac.uk/kbp43231",
"$" + "{python_version_at_least}": "3.8",
"$" + "{python_version_at_least}": "3.9",
}


Expand All @@ -197,4 +197,4 @@ def setup(app):
app.connect("source-read", ultimateReplace)


# dae_devops_fingerprint d6b859985d0506995addfd52cefa3cf1
# dae_devops_fingerprint 404e6b95750b57333b0799fcd1a2c408
Loading

0 comments on commit 1189a5f

Please sign in to comment.