Skip to content

Commit

Permalink
Update builddocs script, update metadata for 4.4.2, update documentat…
Browse files Browse the repository at this point in the history 
…ion (workspace change)
  • Loading branch information
@GeoSander
GeoSander committed Jul 9, 2024
1 parent ebacfdc commit 527b970
Show file tree
Hide file tree
Showing 3 changed files with 68 additions and 12 deletions.
60 changes: 53 additions & 7 deletions docs/builddocs.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@
import argparse
import os
import re
import shlex
import shutil
import traceback
import subprocess
from pathlib import Path
from typing import Tuple
Expand All @@ -37,14 +39,50 @@


def printif(value):
""" Only prints if the value is not None or an empty string. """
if value in (None, ''):
return
print(value)


def update_env_path():
""" Updates the PATH environment variable on Windows by adding the system PATH.
In newer Python environments, the user PATH variable is used instead of the system PATH,
which causes some commands to not be found.
"""

if (os.name != 'nt'):
# Not Windows: nothing to do
return

cmd = 'reg query "HKLM\\SYSTEM\\CurrentControlSet\\Control\\Session Manager\\Environment" /v Path'
proc = subprocess.Popen(shlex.split(cmd), stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)
stdout, _ = proc.communicate()
# Extract the PATH value
path_line = [line for line in stdout.split(' ')][-1]
if path_line and ';' in path_line:
paths = f"{os.environ.get('PATH', '')};{path_line.strip()}"
os.environ['PATH'] = paths


def sh(cmd: str) -> Tuple[int, str]:
""" Execute a shell command. """
proc = subprocess.Popen(cmd.split(), stdout=subprocess.PIPE)
""" Execute a shell command. Returns a tuple of (exit code, stdout). """
args = shlex.split(cmd)
exe = args[0]
if not Path(exe).exists():
# Try to find the executable in the PATH
exe = shutil.which(args[0])
if not exe:
print(f"Executable '{args[0]}' not found - retrying...")
update_env_path()
# Retry with updated PATH (on Windows only)
exe = shutil.which(args[0])
if not exe:
print(f"Executable '{args[0]}' not found - giving up", file=sys.stderr, flush=True)
return 1, "Failed to execute command 'cmd'"
print(f"Found executable '{exe}'")
args[0] = exe
proc = subprocess.Popen(args, stdout=subprocess.PIPE)
stdout, _ = proc.communicate()
return proc.returncode, stdout.decode("utf-8")

Expand Down Expand Up @@ -184,6 +222,8 @@ def build_tag(src_root: Path, dst_root: Path, version: str, html_theme: str = No
return exit_code
src_dir = src_root / "source"
bld_dir = dst_root / version_dir
print(src_root)
print(dst_root)
if os.path.exists(bld_dir):
shutil.rmtree(bld_dir)
os.makedirs(bld_dir)
Expand All @@ -192,7 +232,7 @@ def build_tag(src_root: Path, dst_root: Path, version: str, html_theme: str = No
print(f"HTML theme override '{html_theme}' will be applied")
override = f'-D html_theme={html_theme}'
print(f"Building HTML documentation for {NAME} {version if version != V_LATEST else f'({V_LATEST})'}")
exit_code, result = sh(f"sphinx-build -a {override} {src_dir} {bld_dir}")
exit_code, result = sh(f"sphinx-build -a {override} '{src_dir}' '{bld_dir}'")
printif(result)
if exit_code:
print("Failed to build docs", file=sys.stderr, flush=True)
Expand Down Expand Up @@ -244,11 +284,14 @@ def main():
has_edits = None
try:
curdir = Path.cwd().resolve(strict=True)
print(f"Current directory: {curdir}")
sys.path.insert(0, str(curdir))
docsrc_dir = Path(__file__).parent.resolve(strict=True)
if docsrc_dir.parent != curdir:
sys.path.insert(1, str(docsrc_dir.parent))
print(f"Documentation source directory: {docsrc_dir}")
themes_dir = docsrc_dir / THEMES_DIRNAME
print(f"Themes directory: {themes_dir}")

# Try import something from geocatbridge (conf.py requires it)
from geocatbridge.utils import meta
Expand All @@ -257,6 +300,8 @@ def main():
if args.clean:
clear_target(folder)

print(f"Output directory: {folder}")

# Temporarily disable detached HEAD warnings
sh("git config advice.detachedHead false")

Expand All @@ -266,7 +311,7 @@ def main():
current = current_branch()
working = current or args.branch
if has_edits:
print(f"Current branch{f' {repr(current)}' or ''} has edits: can only build {V_LATEST} version")
print(f"Current branch {(f'{repr(current)} ' if current else '')}has edits: can only build {V_LATEST} version")
if version == V_STABLE:
print(f"Cannot build {V_STABLE} version")
sys.exit(1)
Expand Down Expand Up @@ -296,15 +341,16 @@ def main():
os.chdir(curdir)
else:
# Just create an empty themes dir so Sphinx won't complain
os.makedirs(themes_dir)
os.makedirs(themes_dir, exist_ok=True)

# Build HTML docs
result = build_docs(docsrc_dir, folder, version, html_theme=theme_override, checkout_=checkout_version)

except SystemExit as err:
result = err.code
except Exception as err:
print(f"Aborted script because of unhandled {type(err).__name__}: {err}", file=sys.stderr, flush=True)
print(f"Aborted script because of unhandled {type(err).__name__}: {err}", file=sys.stderr)
print(traceback.format_exc(), file=sys.stderr, flush=True)
if isinstance(err, (ImportError, ModuleNotFoundError)):
sep = '\n\t'
print(f"Python paths:{sep}{f'{sep}'.join(sys.path)}")
Expand All @@ -319,7 +365,7 @@ def main():
print(f"Failed to check out '{current if current else 'default'}' branch", file=sys.stderr, flush=True)
else:
print(output)
print("Done")
print("Done")
sys.exit(result)


Expand Down
10 changes: 7 additions & 3 deletions docs/source/publish.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,16 +104,20 @@ Click on this button to open another dialog that will display all the warning or
.. warning:: **It is currently not possible to add layers to an existing workspace.**

Each time you publish layers to an existing GeoServer workspace, all data in that workspace will be removed.
Each time you publish layers to a GeoServer workspace that already exists, that workspace will be purged and recreated.
|short_name| will warn you if this is about to happen:

.. image:: ./img/publish_workspace_warning.png
:align: center

|
If you do not want to clear the entire workspace, you could save your QGIS project under a different
name and re-publish the layers. This will create a new workspace on the server and keep the old one.
*New in version 4.4.2*: Even though all datastores and styles in the workspace will be removed, the old workspace settings
and ACL rules will be preserved. This means that you do not have to manually restore those settings.

If you do not want to clear the entire workspace and keep the old one, you could rename your QGIS project or save it
under a different name and re-publish the layers. This will create a new workspace on the server using the default settings,
and preserve the old one.


View published layers on server(s)
Expand Down
10 changes: 8 additions & 2 deletions geocatbridge/metadata.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ about=GeoCat is pleased to offer its Bridge plugin to the QGIS community.
experimental=False
category=Web
qgisMinimumVersion=3.16
version=4.4.1
version=4.4.2
email=support@geocat.net
icon=icons/geocat.png
tags=style, symbology, cartography, publishing, sharing, SDI, metadata, MapServer,
Expand All @@ -24,7 +24,13 @@ tracker=https://github.com/GeoCat/qgis-bridge-plugin/issues
repository=https://github.com/GeoCat/qgis-bridge-plugin
hasProcessingProvider=yes
deprecated=False
changelog=Version 4.4.1, March 2024
changelog=Version 4.4.2, July 2024
- Fix crash when temporary layer path/URI is too long
- Improve workspace handling (preserve ACLs, settings, etc. - thanks @ Johannes Kröger)
- Build About page dynamically (thanks @ Johannes Kröger)
- bridgestyle: label fix for MapBox GL (thanks @ Gerald Kogler)

Version 4.4.1, March 2024
- Fixed documentation link
- Support temporary layers when source is a path
- bridgestyle: MapBox GL improvements, QGIS 3.16 crash fix, fix color parsing
Expand Down

0 comments on commit 527b970

Please sign in to comment.