Skip to content

Commit

Permalink
Merge branch 'master' into dependabot/pip/pytz-2024.2
Browse files Browse the repository at this point in the history
  • Loading branch information
submarcos authored Nov 25, 2024
2 parents edaccfa + 45fd2a2 commit 3a7107c
Show file tree
Hide file tree
Showing 57 changed files with 1,796 additions and 188 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/dependencies.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: ['ubuntu-20.04']
os: ['ubuntu-latest']
python-version: ['3.8']

steps:
Expand All @@ -31,6 +31,7 @@ jobs:

- name: Install dependencies
run: |
pip3 install -U "pip<24.3" # prevent relative bug path with pip 24.3 and pip-tools
pip3 install -c dev-requirements.txt pip-tools
- name: Check dependency graph
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ jobs:
name: coverage_${{ matrix.os }}_${{ matrix.tests-env }}
path: .

- uses: codecov/codecov-action@v4
- uses: codecov/codecov-action@v5
with:
files: ./coverage.xml
env_vars: OS,ENV
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -62,3 +62,4 @@ docs/_build/
/dpkg/
/coverage.lcov
/htmlcov/
/.cache/
6 changes: 3 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ COLOR_DEBUG = \033[36m
COLOR_RESET = \033[0m

build:
docker build -t geotrek . --build-arg BASE_IMAGE_TAG=$(BASE_IMAGE_TAG)
docker build -t geotrek -f docker/Dockerfile . --build-arg BASE_IMAGE_TAG=$(BASE_IMAGE_TAG)

build-no-cache:
docker build -t geotrek --no-cache .
build_no_cache:
docker build -t geotrek -f docker/Dockerfile --no-cache .

build_deb:
docker pull $(DISTRO)
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2.109.3+dev
2.110.0+dev
12 changes: 6 additions & 6 deletions cypress/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 9 additions & 3 deletions debian/changelog
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
geotrek-admin (2.109.3+dev) UNRELEASED; urgency=medium
geotrek-admin (2.110.0+dev) UNRELEASED; urgency=medium

*
*

-- Célia Prat <[email protected]> Mon, 04 Nov 2024 14:01:07 +0100
-- Justine Fricou <[email protected]> Wed, 13 Nov 2024 11:09:31 +0100

geotrek-admin (2.110.0) RELEASED; urgency=medium

* New package release

-- Justine Fricou <[email protected]> Wed, 13 Nov 2024 10:46:20 +0100

geotrek-admin (2.109.3) RELEASED; urgency=medium

Expand Down
4 changes: 2 additions & 2 deletions docker/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ ENV TZ=UTC

WORKDIR /opt/geotrek-admin
RUN mkdir -p /opt/geotrek-admin/var/log /opt/geotrek-admin/var/cache
RUN useradd -M -s /bin/false geotrek && chown geotrek:geotrek -R /opt
RUN useradd -m -d /opt/geotrek-admin -s /bin/false geotrek && chown geotrek:geotrek -R /opt

# Install postgis because raster2pgsl is required by manage.py loaddem
RUN apt-get update -qq && apt-get install -y -qq \
Expand Down Expand Up @@ -70,7 +70,7 @@ RUN apt-get update -qq && apt-get install -y -qq \

USER geotrek
RUN python3 -m venv /opt/venv
RUN /opt/venv/bin/pip install --no-cache-dir -U pip setuptools wheel
RUN /opt/venv/bin/pip install --no-cache-dir -U "pip<24.3" setuptools wheel
COPY requirements.txt requirements.txt
RUN /opt/venv/bin/pip install --no-cache-dir -r requirements.txt -U

Expand Down
24 changes: 23 additions & 1 deletion docs/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,31 @@
CHANGELOG
=========

2.109.3+dev (XXXX-XX-XX)
2.110.0+dev (XXXX-XX-XX)
----------------------------

**Improvements**

- Remove overriding of SchemaRandonneeParser's filetype_name attribute (#4022)

**Bug fixes**

- Fix missing Dockerfile path on make build scripts
- Fix SchemaRandonneeParser url update when description is null or was not updated (#4022)

**Documentation**

- Update documentation for release and update obsolete example
- Add note about certbot ssl configuration in nginx


2.110.0 (2024-11-13)
----------------------------

**New features**

- Add parser for schema_randonnee-compliant files (#4022)


2.109.3 (2024-10-29)
----------------------------
Expand Down
94 changes: 74 additions & 20 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
import sphinx_rtd_theme # noqa
import datetime
import os

root = os.path.abspath(os.path.dirname(os.path.dirname(__file__)))

extensions = [
'sphinx.ext.todo',
'sphinx_rtd_theme',
"sphinx_immaterial"
]

html_theme = 'sphinx_immaterial'
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

Expand All @@ -16,29 +19,78 @@
master_doc = 'index'

# General information about the project.
project = 'Geotrek'
project = 'Geotrek-admin'
copyright = f'2013-{datetime.date.today().year}, Makina Corpus'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '2.109'
# The full version, including alpha/beta/rc tags.
release = '2.109.3+dev'

exclude_patterns = ['_build']

pygments_style = 'sphinx'

html_theme = 'sphinx_rtd_theme'

html_logo = "_static/logo.svg"

# Material theme options (see theme.conf for more information)
html_theme_options = {
"logo_only": True,
'style_external_links': True,
"icon": {
"repo": "fontawesome/brands/github",
"edit": "material/file-edit-outline",
},
"site_url": "https://geotrek.fr/",
"repo_url": "https://github.com/GeotrekCE/Geotrek-admin/",
"repo_name": "Geotrek-admin",
"edit_uri": "blob/main/docs",
"globaltoc_collapse": True,
"features": [
"navigation.expand",
# "navigation.tabs",
# "toc.integrate",
"navigation.sections",
# "navigation.instant",
# "header.autohide",
"navigation.top",
# "navigation.tracking",
# "search.highlight",
"search.share",
"toc.follow",
"toc.sticky",
"content.tabs.link",
"announce.dismiss",
],
"palette": [
{
"media": "(prefers-color-scheme: light)",
"scheme": "default",
"primary": "green",
"accent": "light green",
"toggle": {
"icon": "material/weather-night",
"name": "Switch to dark mode",
},
},
{
"media": "(prefers-color-scheme: dark)",
"scheme": "slate",
"primary": "green",
"accent": "light green",
"toggle": {
"icon": "material/weather-sunny",
"name": "Switch to light mode",
},
},
],
"social": [
{
"icon": "fontawesome/brands/github",
"link": "https://github.com/GeotrekCE/Geotrek-admin"
},
{
"icon": "fontawesome/brands/linkedin",
"link": "https://www.linkedin.com/company/geotrek-application",
},
],
"toc_title_is_page_title": True,
}

html_favicon = "_static/favicon.png"

html_static_path = ['_static']
Expand All @@ -47,17 +99,19 @@
htmlhelp_basename = 'Geotrekdoc'

latex_documents = [
('index', 'Geotrek.tex', 'Geotrek Documentation',
('index', 'Geotrek.tex', 'Geotrek-admin Documentation',
'Makina Corpus', 'manual'),
]

man_pages = [
('index', 'geotrek', 'Geotrek Documentation',
('index', 'geotrek', 'Geotrek-admin Documentation',
['Makina Corpus'], 1)
]

html_sidebars = {
"**": ["logo-text.html", "globaltoc.html", "localtoc.html", "searchbox.html"]
}
texinfo_documents = [
('index', 'Geotrek', 'Geotrek Documentation',
'Makina Corpus', 'Geotrek', 'One line description of project.',
('index', 'Geotrek', 'Geotrek-admin Documentation',
'Makina Corpus', 'Geotrek-admin', 'One line description of project.',
'Miscellaneous'),
]
10 changes: 5 additions & 5 deletions docs/contribute/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -103,16 +103,16 @@ Release

On master branch:

* Update files *VERSION*, *docs/conf.py* and *docs/changelog.rst* to remove ``+dev`` suffix and increment version (please use semver rules)
* Update files *VERSION* and *docs/changelog.rst* to remove ``+dev`` suffix and increment version (please use semver rules)
* Run ``dch -r -D RELEASED``, update version in the same way and save
* Commit with message 'Release x.y.z' and push to ``master``
* Create new release on Github, with tag X.Y.Z, click on "Generate release notes"
* Commit with message 'Release X.Y.Z' and push to ``master``
* Create new release with name 'Geotrek-admin X.Y.Z' on Github, with tag X.Y.Z, click on "Generate release notes"
* Wait for release to be published through CI
* Update files *VERSION*, *docs/conf.py* and *docs/changelog.rst* to add ``+dev`` suffix
* Update files *VERSION* and *docs/changelog.rst* to add ``+dev`` suffix
* Run ``dch -v <version>+dev --no-force-save-on-release`` and save
* Commit with message 'Back to development' and push to ```master``

* When creating a new release 'x.y.z' on github, Github actions will generate the .deb package file, and publish it on https://packages.geotrek.fr (see ``.github/workflows/test.yml`` file for details)
* When creating a new release 'X.Y.Z' on github, Github actions will generate the .deb package file, and publish it on https://packages.geotrek.fr (see ``.github/workflows/test.yml`` file for details)

Other ways to contribute
-------------------------
Expand Down
6 changes: 4 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
Welcome to Geotrek's documentation!
===================================
Geotrek-admin's documentation
=============================

Geotrek-admin is backend management data for Geotrek-rando, Geotrek-mobile and Geotrek-widget.

.. toctree::
:caption: 💡 About
Expand Down
10 changes: 6 additions & 4 deletions docs/install/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,11 +71,13 @@ After this, edit ``nginx.conf.in`` to add your certificate.

If you generate it with letsencrypt :
You can use certbot to add the certificate in your configuration.
But you will have to move the configuration automatically added into ``nginx.conf``, to the file ``nginx.conf.in``
in ``/opt/geotrek-admin/var/conf/`` directory
But you will have to move the configuration automatically added into ``nginx.conf``, to the file ``nginx.conf.in`` in ``/opt/geotrek-admin/var/conf/`` directory.

You have to move the configuration to the file ``nginx.conf.in`` because ``nginx.conf`` is automatically
changed during command ``dpkg-reconfigure geotrek-admin``.
You have to move the configuration to the file ``nginx.conf.in`` because ``nginx.conf`` is automatically changed during command ``dpkg-reconfigure geotrek-admin``.

.. note::

You need to replace the ``$`` from Certbot with ``${DOLLAR}`` everywhere in the ``nginx.conf.in`` file, then run the command ``sudo dpkg-reconfigure geotrek-admin`` to regenerate the file.


Mandatory settings
Expand Down
4 changes: 1 addition & 3 deletions docs/install/maintenance.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,9 @@ Application restore
If you restore Geotrek-admin on a new server, you will have to install PostgreSQL and PostGIS and create a database user first.
Otherwise go directly to the database creation step.

Example for Ubuntu 18:

.. code-block:: bash
sudo apt install postgresql-10 postgresql-10-postgis-2.5
sudo apt install postgresql-14 postgresql-14-postgis-3
sudo -u postgres psql -c "CREATE USER geotrek PASSWORD 'geotrek';"
Expand Down
4 changes: 1 addition & 3 deletions docs/requirements.in
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
-c ../dev-requirements.in

sphinx-rtd-theme>=1.0.0
sphinx_immaterial
sphinx>=4.0.0
sphinx-autobuild
sphinx-intl
Loading

0 comments on commit 3a7107c

Please sign in to comment.