Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upgrade and pin dependencies #111

Merged
merged 1 commit into from
Aug 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/testing.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ jobs:
runs-on: ubuntu-latest # operating system your code will run on
services:
postgres:
image: postgres:13
image: postgres:16
env:
POSTGRES_USER: sadilar
POSTGRES_PASSWORD: sadilar
Expand Down
2 changes: 1 addition & 1 deletion app/templates/base.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/font/bootstrap-icons.min.css" integrity="sha256-9kPW/n5nn53j4WMRYAxe9c1rCY96Oogo/MKSVdKzPmI=" crossorigin="anonymous">
<link rel="icon" href="{% static 'img/favicon.png' %}" sizes="32x32" />
{# htmx JS at the end of body seems to create problems when navigating through browser history #}
<script src="https://cdn.jsdelivr.net/npm/[email protected].1/dist/htmx.min.js" integrity="sha256-bUqqSw0+i0yR+Nl7kqNhoZsb1FRN6j9mj9w+YqY5ld8=" crossorigin="anonymous"></script>
<script src="https://cdn.jsdelivr.net/npm/[email protected].2/dist/htmx.min.js" integrity="sha256-4XRtl1nsDUPFwoRFIzOjELtf1yheusSy3Jv0TXK1qIc=" crossorigin="anonymous"></script>
<meta name="htmx-config" content='{% include "app/htmx-config.json" %}'>
<style>{% include "app/css/local.css" %}</style>
</head>
Expand Down
48 changes: 48 additions & 0 deletions doc/upgrades.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
Upgrades
========
Dependencies are currently spread out in a number of areas. This file tries to
summarise them.

Policy around upgrades will eventually emerge. At the start of the project, the
focus is on the future, and therefore on the latest versions, possibly with a
focus on long-term support (LTS) versions.


Python
------
See the Python version in `Dockerfile`, and maybe in some CI related bits.

PostgreSQL
----------
Check `docker-compose.ytml`, test setups in CI and probably things in any real
deployments.

Python dependencies
-------------------
Review `requirements.txt` and related files. We should still move to transitive
pinning with something like poetry in future. We upgrade Django aggressively
until we reach version 5.2 (LTS), and after that we will likely stay on LTS
releases.

Look up each package at https://pypi.org/

CSS
---
Bootstrap is the main consideration. Versions are available here:
https://getbootstrap.com/docs/versions/

To review supported devices, see the appropriate page for the version, e.g.
https://getbootstrap.com/docs/5.3/getting-started/browsers-devices/

Obviously you might want to consider support information from
https://caniuse.com or MDN
https://developer.mozilla.org/en-US/docs/Web/CSS/word-break

JavaScript
----------
We try to keep JS dependencies minimal. Check `base.html`. Obviously some JS is
also included via Django, but we only consider Django as a whole. Some minimal
JS is also part of Bootstrap (see above).

For HTMX, release information is available here:
https://github.com/bigskysoftware/htmx/releases
2 changes: 1 addition & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

services:
db:
image: postgres:12
image: postgres:16
container_name: sadilar-terminology-db
environment:
- POSTGRES_DB=term_db
Expand Down
2 changes: 1 addition & 1 deletion requirements-dev.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
-r requirements.txt
django-debug-toolbar
django-extensions
faker
pygraphviz
ruff
faker
2 changes: 1 addition & 1 deletion requirements-test.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
-r requirements.txt
django-debug-toolbar
django-extensions
ruff
faker
ruff
22 changes: 11 additions & 11 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
django==5.0.6
django-environ
django-htmx
django-simple-history
gunicorn
psycopg2-binary
whitenoise
pillow
python-magic
pypdf
django-filter
django-environ==0.11.2
django-filter==24.3
django-htmx==1.19.0
django-simple-history==3.7.0
django==5.0.8
gunicorn==23.0.0
pillow==10.4.0
psycopg2-binary==2.9.9
pypdf==4.3.1
python-magic==0.4.27
whitenoise==6.7.0
Loading