Mercurial > p > roundup > code
changeset 8063:6d4b5005abf2
docs: changes to website docs to announce CVE's
Changes to the website doc generation to create CVE.html by extracing
secions from upgrading.txt. It also allows overriding the release
version that is displayed in the web page titles.
It also adds support for making a zipfile (which is better supported
on windows that a tarball) of the templates needed to address the CVE
in the tracker home html files
The next commit for this directory will remove the generation of the
CVE.html file as CVE remediation/scope issue will be in the
upgrading.html document. It will also remove generation of
templates.zip.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Tue, 09 Jul 2024 09:12:29 -0400 |
| parents | 28aa76443f58 |
| children | d6b447de4f59 |
| files | website/www/Makefile website/www/conf.py website/www/contents.txt |
| diffstat | 3 files changed, 18 insertions(+), 4 deletions(-) [+] |
line wrap: on
line diff
--- a/website/www/Makefile Tue Jul 09 09:07:09 2024 -0400 +++ b/website/www/Makefile Tue Jul 09 09:12:29 2024 -0400 @@ -11,9 +11,11 @@ @echo " production website" @echo " sourceforge_dev_sync sync html directory to sourceforce" @echo " /dev_docs subdirectory" + @echo " sourceforge_home_sync sync html directory to" + @echo " sourceforge:~/roundup_docs" @echo " clean remove all produced files" clean: - -rm -rf $(TMP) $(HTML) docs COPYING.txt + -rm -rf $(TMP) $(HTML) docs COPYING.txt templates.zip docs: ln -s ../../doc ./docs @@ -22,7 +24,7 @@ # after upgrade to sphinx 1.8.5, search.html is missing load of searchtools. # fix that in postprocess # also sed index.html to properly format meta og:... entries. -html: docs +html: docs templates.zip rm -rf html mkdir -p $(TMP)/doctrees $(HTML) sphinx-build -n -W -b html -d $(TMP)/doctrees . $(HTML) @@ -39,6 +41,8 @@ @echo; \ l=$$(find html -name '*.orig' -o -name '*~' | tee /dev/tty | wc -l);\ if [ $$l -ne 0 ]; then echo "Garbage files found" && false; fi + if [ -e templates.zip ]; then cp templates.zip \ + html/CVE-2024-39124-templates.zip; fi linkcheck: mkdir -p $(TMP)/linkcheck $(TMP)/doctrees @@ -47,6 +51,11 @@ @echo "Link check complete; look for any errors in the above output " \ "or in .build/linkcheck/output.txt." +templates.zip: + rm -f templates.zip + (cd ../../share/roundup; hg status -A templates | \ + sed -ne '/^[AMC]/s/^..//p' | sort | zip -@ - ) > templates.zip + sourceforge_dev_sync: # --no-times makes _images/* and other files sync over every time # so docs_backup-... is complete with all files and can be served
--- a/website/www/conf.py Tue Jul 09 09:07:09 2024 -0400 +++ b/website/www/conf.py Tue Jul 09 09:12:29 2024 -0400 @@ -26,8 +26,12 @@ DOCROOT = os.path.abspath(os.path.dirname(__file__) + "/..") sys.path = [os.path.dirname(DOCROOT)] try: - from roundup import __version__ as VERSION - SHORTVER = '.'.join(VERSION.split('.', 2)[:2]) + if "RELEASE_VERSION" in os.environ: + SHORTVER = '.'.join(os.environ['RELEASE_VERSION'].split('.', 2)[:2]) + VERSION = os.environ['RELEASE_VERSION'] + else: + from roundup import __version__ as VERSION + SHORTVER = '.'.join(VERSION.split('.', 2)[:2]) except ImportError: VERSION = SHORTVER = '(unknown version)' finally: