Skip to content

Commit 0dd4d93

Browse files
committed
Merge branch 'single-release-per-major__master'
2 parents 91dab22 + ae134d2 commit 0dd4d93

10 files changed

+136
-79
lines changed

docs/_config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ url: 'https://sinonjs.org'
66
github_username: sinonjs
77
sinon:
88
current_release: v13.0.0
9+
current_major_version: 13
910
markdown: kramdown
1011
kramdown:
1112
input: GFM

docs/_includes/head.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,19 @@
1212

1313
{% comment %}
1414
To make all documentation pages, regardless of version, lead search traffic to the latest version,
15-
we need to point all the pages under /releases/v*/ to their latest version
15+
we need to point all the pages under /releases/v*/ to the latest version
1616
{% endcomment %}
1717

1818
{% assign url_parts = page.url | split: "/" %}
1919

2020
{% if page.url contains "/releases/v" } %}
2121
{% assign canonical_page_url = "/releases/latest/" | append: url_parts[3] %}
2222

23-
{% if url_parts[2] != {site.sinon.current_release} %}
24-
<script>
25-
site.showBanner = true; // cannot dynamically create a globally available Liquid variable
26-
</script>
27-
{% endif %}
23+
<script>
24+
const releaseVersionWithPrefix = "{{ url_parts[2]}}";
25+
const majorVersion = "{{site.sinon.current_major_version}}"
26+
site.showBanner = releaseVersionWithPrefix != `v${majorVersion}`; // cannot dynamically create a globally available Liquid variable
27+
</script>
2828
{% else %}
2929
{% assign canonical_page_url = page.url | replace:'index.html','' %}
3030
{% endif %}

docs/_includes/header.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
</a>
88
</div>
99
<ul class="nav navbar-nav navbar-right">
10-
<li><a href="{{ site.baseurl }}/releases/{{site.sinon.current_release}}">Documentation</a></li>
10+
<li><a href="{{ site.baseurl }}/releases/v{{site.sinon.current_major_version}}">Documentation</a></li>
1111
<li><a href="{{ site.baseurl }}/releases/">Releases</a></li>
1212
<li><a href="{{ site.baseurl }}/guides/">Guides</a></li>
1313
<li><a href="{{ site.baseurl }}/how-to/">How To</a></li>

docs/index.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
---
55

66
{% assign current_release = site.sinon.current_release %}
7+
{% assign current_major = site.sinon.current_major_version %}
78

89
## Get Started
910

@@ -284,9 +285,9 @@ You've seen the most common tasks people tackle with Sinon.JS, yet we've only sc
284285

285286
Christian Johansen's book [Test-Driven JavaScript Development][tddjs] covers some of the design philosophy and initial sketches for Sinon.JS.
286287

287-
[fakes]: /releases/{{current_release}}/fakes
288-
[fakexhr]: /releases/{{current_release}}/fake-xhr-and-server
289-
[fakeserver]: /releases/{{current_release}}/fake-xhr-and-server#fake-server
290-
[clock]: /releases/{{current_release}}/fake-timers
291-
[api-docs]: /releases/{{current_release}}
288+
[fakes]: /releases/v{{current_major}}/fakes
289+
[fakexhr]: /releases/v{{current_major}}/fake-xhr-and-server
290+
[fakeserver]: /releases/v{{current_major}}/fake-xhr-and-server#fake-server
291+
[clock]: /releases/v{{current_major}}/fake-timers
292+
[api-docs]: /releases/v{{current_major}}
292293
[tddjs]: http://tddjs.com/

docs/release-source/release.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ layout: page
33
title: API documentation - Sinon.JS
44
skip_ad: true
55
release_id: master
6+
sort_id: master
67
---
78

89
# {{page.title}} - `{{page.release_id}}`

docs/releases.html

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ <h1>Releases</h1>
1818

1919
<div class="in-content releases">
2020
<ul>
21-
{% assign sorted_releases = site.releases | sort | reverse %}
21+
{% assign sorted_releases = site.releases | sort: "sort_id" | reverse %}
2222
{% for release in sorted_releases %}
2323
{% assign url_parts = release.url | split: "/" %}
2424

@@ -65,3 +65,7 @@ <h2 id="npm-cdns">Using NPM based CDNs</h2>
6565
would download the latest browser bundle of Sinon 3.
6666
</p>
6767
</div>
68+
69+
{% comment %}
70+
vim: ft=liquid
71+
{%endcomment %}

package-lock.json

Lines changed: 100 additions & 55 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,7 @@
101101
"proxyquireify": "^3.2.1",
102102
"puppeteer": "^13.1.2",
103103
"rimraf": "^3.0.2",
104+
"semver": "^7.3.5",
104105
"shelljs": "^0.8.4"
105106
},
106107
"files": [

0 commit comments

Comments
 (0)