Skip to content

Commit 61f3c17

Browse files
committed
versioning
1 parent 48f52da commit 61f3c17

File tree

3 files changed

+21
-2
lines changed

3 files changed

+21
-2
lines changed

.github/workflows/docs.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ on:
44
release:
55
types: [published]
66
workflow_dispatch:
7+
inputs:
8+
selected_version:
9+
description: 'Tag to associate with current working tree. If unset, `git describe` is used.'
10+
type: string
11+
required: false
712
pull_request: # TODO
813

914
jobs:
@@ -25,7 +30,11 @@ jobs:
2530
uses: astral-sh/setup-uv@v7
2631
- name: Install just
2732
run: sudo apt install -y just
33+
- name: Build documentation (explicit selected version)
34+
if: github.event_name == 'workflow_dispatch' && inputs.selected_version
35+
run: cd docs && just latest_version=${{ inputs.selected_version }} all
2836
- name: Build documentation
37+
if: github.event_name != 'workflow_dispatch' || !inputs.selected_version
2938
run: cd docs && just all
3039
- name: Upload pages artifact
3140
id: deployment

docs/header.html.jinja

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,14 @@
66
<li><a href="{{ version_root }}/{{ path_javadoc }}">Javadoc</a></li>
77
<li><a href="https://github.com/yawkat/lz4-java{% if selected_version != latest_version_name %}/releases/tag/{{ selected_version_actual }}{% endif %}">GitHub</a></li>
88
<li>
9-
<span>{{ selected_version }} ▼</span>
9+
<span>{% if selected_version == latest_version_name %}{{ latest_version }} ({{ selected_version }}){% else %}{{ selected_version }}{% endif %} ▼</span>
1010
<ul class="dropdown">
11+
{% if latest_version not in all_versions %}
12+
<li>
13+
{% if latest_version_name == selected_version %}<span class="selected">{{ latest_version }} (snapshot)</span>
14+
{% else %}<a href="REWRITE_PATH_{{ latest_version_name }}">{{ latest_version }} (snapshot)</a>{% endif %}
15+
</li>
16+
{% endif %}
1117
{% for v in all_versions %}
1218
<li>
1319
{% if v == selected_version %}<span class="selected">{{ v }}</span>

docs/justfile

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,5 +97,9 @@ prepare:
9797
mkdir -p '{{build}}/site'
9898
ln -s ../../javadoc.css ../../common.css ../../markdown.css '{{build}}/site'
9999

100-
all: prepare (version latest_version_name) && rewrite-version-links
100+
log:
101+
@echo "Available tags: {{all_versions}}"
102+
@echo "Current tag: {{latest_version}}"
103+
104+
all: log prepare (version latest_version_name) && rewrite-version-links
101105
set -e; for v in {{all_versions}}; do just 'all_versions={{all_versions}}' 'latest_version={{latest_version}}' version "$v"; done

0 commit comments

Comments
 (0)