Skip to content

Commit 113511a

Browse files
committed
Fix reference selection and default filters
1 parent 5fedeb5 commit 113511a

File tree

2 files changed

+15
-7
lines changed

2 files changed

+15
-7
lines changed

exasol/toolbox/sphinx/multiversion/main.py

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ def load_sphinx_config_worker(q, confpath, confoverrides, add_defaults):
5959
)
6060
current_config.add(
6161
"smv_branch_whitelist",
62-
sphinx.DEFAULT_TAG_WHITELIST,
62+
sphinx.DEFAULT_BRANCH_WHITELIST,
6363
"html",
6464
str,
6565
)
@@ -286,13 +286,13 @@ def _main(args, argv):
286286
conffile = os.path.join(confdir, "conf.py")
287287

288288
# Get git references
289-
gitrefs = git.get_refs(
289+
gitrefs = list(git.get_refs(
290290
str(gitroot),
291291
config.smv_tag_whitelist,
292292
config.smv_branch_whitelist,
293293
config.smv_remote_whitelist,
294294
files=(sourcedir, conffile),
295-
)
295+
))
296296

297297
# Order git refs
298298
if config.smv_prefer_remote_refs:
@@ -581,14 +581,22 @@ def _main(args, argv):
581581
with open(
582582
os.path.join(args.outputdir, "index.html"), "w", encoding="utf-8"
583583
) as f:
584-
versions = [
584+
logger.debug("Picked up Git references: %s", [ref.name for ref in gitrefs])
585+
tag_versions = [
585586
ref.name
586587
for ref in gitrefs
587588
if re.match(config.smv_tag_whitelist, ref.name)
588589
]
589-
versions = sorted(
590-
versions, key=lambda v: ExasolVersion.from_string(v), reverse=True
590+
tag_versions = sorted(
591+
tag_versions, key=lambda v: ExasolVersion.from_string(v), reverse=True
591592
)
593+
branches = [
594+
ref.name
595+
for ref in gitrefs
596+
if re.match(config.smv_branch_whitelist, ref.name)
597+
]
598+
versions = branches + tag_versions
599+
logger.debug("Selected versions for documentation: %s", versions)
592600
f.write(template.render(version=versions[0]))
593601

594602
return 0

exasol/toolbox/sphinx/multiversion/sphinx.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
DATE_FMT = "%Y-%m-%d %H:%M:%S %z"
1818
DEFAULT_TAG_WHITELIST = r"^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$"
19-
DEFAULT_BRANCH_WHITELIST = r"master|main"
19+
DEFAULT_BRANCH_WHITELIST = r"^(master|main)"
2020
DEFAULT_REMOTE_WHITELIST = None
2121
DEFAULT_RELEASED_PATTERN = r"^tags/.*$"
2222
DEFAULT_OUTPUTDIR_FORMAT = r"{ref.name}"

0 commit comments

Comments
 (0)