Skip to content

Commit 3b1e667

Browse files
georgestagggeorgestagg
committed
Rework branch/tag versioning in docs
Also adds `webR.version` property (Fixes #409).
1 parent 57f9ead commit 3b1e667

17 files changed

+79
-52
lines changed

‎.github/workflows/deploy.yml

+15
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,21 @@ jobs:
4141
- name: Set the webR CDN URL as the BASE_URL
4242
run: echo "BASE_URL=https://webr.r-wasm.org/${{ github.ref_name }}/" > "$HOME/.webr-config.mk"
4343
shell: bash
44+
- name: Set versioning for main
45+
if: "contains(github.ref_name, 'main')"
46+
run: |
47+
SHA="${{github.event.pull_request.head.sha}}${{ github.sha }}"
48+
SHORT_SHA=${SHA:0:7}
49+
VER=$(node -p "require('./src/package.json').version")
50+
echo "WEBR_VERSION=${VER}+${SHORT_SHA}" > "$HOME/.webr-config.mk"
51+
echo "WEBR_VERSION_TAG=latest" > "$HOME/.webr-config.mk"
52+
- name: Set versioning for tag
53+
if: "!contains(github.ref_name, 'main')"
54+
run: |
55+
VER=$(node -p "require('./src/package.json').version")
56+
echo "WEBR_VERSION=${VER}" > "$HOME/.webr-config.mk"
57+
echo "WEBR_VERSION_TAG=${{ github.ref_name }}" > "$HOME/.webr-config.mk"
58+
shell: bash
4459
- name: Build all optional wasm libs
4560
env:
4661
EMSDK: /opt/emsdk

‎flake.lock

+3-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎flake.nix

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
# cd src; prefetch-npm-deps package-lock.json
2727
srcNpmDeps = pkgs.fetchNpmDeps {
2828
src = "${self}/src";
29-
hash = "sha256-s3QeJV3RhqizVCrswEEJj5RBhvU9jcxai4GYg92MOJ4=";
29+
hash = "sha256-SyGWR07KAthTG5IA/906eloVApfGha5NCwvJpI+9raQ=";
3030
};
3131

3232
inherit system;

‎packages/webr/DESCRIPTION

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Type: Package
22
Package: webr
33
Title: WebR Support Package
4-
Version: 0.3.2
4+
Version: 0.3.2.9000
55
Authors@R: c(
66
person("George", "Stagg", , "[email protected]", role = c("aut", "cre")),
77
person("Lionel", "Henry", , "[email protected]", role = "aut"),

‎src/Makefile

+5-2
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ TS_SOURCES = $(shell find $(ROOT) \
1717

1818
BASE_URL ?= "./"
1919
PKG_BASE_URL ?= "https://repo.r-wasm.org"
20+
WEBR_VERSION ?= $(shell node -p "require('./package.json').version")
2021

2122
HTML_DIST = $(addprefix $(DIST)/,$(HTML_TEMPLATES))
2223
$(DIST)/webr.mjs: $(TS_SOURCES) $(HTML_DIST) \
@@ -26,11 +27,13 @@ $(DIST)/webr.mjs: $(TS_SOURCES) $(HTML_DIST) \
2627

2728
$(DIST)/%.html: templates/%.html
2829
sed -e "s|@@BASE_URL@@|$(BASE_URL)|" \
29-
-e "s|@@PKG_BASE_URL@@|$(PKG_BASE_URL)|" $< > $@
30+
-e "s|@@PKG_BASE_URL@@|$(PKG_BASE_URL)|" \
31+
-e "s|@@WEBR_VERSION@@|$(WEBR_VERSION)|" $< > $@
3032

3133
webR/config.ts: webR/config.ts.in
3234
sed -e "s|@@BASE_URL@@|$(BASE_URL)|" \
33-
-e "s|@@PKG_BASE_URL@@|$(PKG_BASE_URL)|" webR/config.ts.in > webR/config.ts
35+
-e "s|@@PKG_BASE_URL@@|$(PKG_BASE_URL)|" \
36+
-e "s|@@WEBR_VERSION@@|$(WEBR_VERSION)|" webR/config.ts.in > webR/config.ts
3437

3538
.PHONY: lint
3639
lint: $(DIST)

‎src/docs/Makefile

+7-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
11
TS_SOURCES = $(shell find .. -name '*.ts' -not -path '../node_modules/*')
2-
QMD_SOURCES = $(shell find . -name '*.qmd')
2+
QMD_SOURCES = $(shell find . -name '*.qmd') _quarto.yml
3+
4+
-include ~/.webr-config.mk
5+
WEBR_VERSION ?= $(shell node -p "require('../package.json').version")
6+
WEBR_VERSION_TAG ?= latest
37

48
_site: api/js $(QMD_SOURCES)
5-
quarto render
9+
WEBR_VERSION=$(WEBR_VERSION) WEBR_VERSION_TAG=$(WEBR_VERSION_TAG) \
10+
quarto render
611

712
api/js: $(TS_SOURCES)
813
cd .. && make node_modules

‎src/docs/_quarto.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ website:
1515
favicon: images/webR.png
1616
page-navigation: true
1717
sidebar:
18-
title: "WebR 0.3.2 Documentation"
18+
title: "WebR {{< env WEBR_VERSION >}} Documentation"
1919
logo: images/webR.png
2020
contents:
2121
- index.qmd

‎src/docs/examples.qmd

+4-4
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ In this example, R executes a plotting command and webR's output message queue i
254254
<canvas id="plot-canvas" width="1008" height="1008"></canvas>
255255

256256
<script type="module">
257-
import { WebR } from 'https://webr.r-wasm.org/latest/webr.mjs';
257+
import { WebR } from 'https://webr.r-wasm.org/{{< env WEBR_VERSION_TAG >}}/webr.mjs';
258258
const webR = new WebR();
259259
260260
await webR.evalRVoid(`
@@ -344,7 +344,7 @@ The following HTML document loads webR from CDN and creates a simple interactive
344344

345345
<script type="module">
346346
/* Create a webR console using the Console helper class */
347-
import { Console } from 'https://webr.r-wasm.org/latest/webr.mjs';
347+
import { Console } from 'https://webr.r-wasm.org/{{< env WEBR_VERSION_TAG >}}/webr.mjs';
348348
const webRConsole = new Console({
349349
stdout: line => document.getElementById('out').append(line + '\n'),
350350
stderr: line => document.getElementById('out').append(line + '\n'),
@@ -388,7 +388,7 @@ After loading, the resulting web page should present an interactive R console si
388388
</div>
389389
</div>
390390
<script type="module">
391-
import { Console } from 'https://webr.r-wasm.org/v0.3.2/webr.mjs';
391+
import { Console } from 'https://webr.r-wasm.org/{{< env WEBR_VERSION_TAG >}}/webr.mjs';
392392
const webRConsole = new Console({
393393
stdout: line => document.getElementById('out').append(line + '\n'),
394394
stderr: line => document.getElementById('out').append(line + '\n'),
@@ -434,7 +434,7 @@ Using the [`plotly`](https://plotly.com/r/getting-started/) R package, `ggplot2`
434434
</div>
435435

436436
<script type="module">
437-
import { WebR } from 'https://webr.r-wasm.org/latest/webr.mjs';
437+
import { WebR } from 'https://webr.r-wasm.org/{{< env WEBR_VERSION_TAG >}}/webr.mjs';
438438
const webR = new WebR({ interactive: false });
439439
await webR.init();
440440
const outElem = document.getElementById('out');

‎src/docs/index.qmd

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ summary(fit)</div>
3939
editor.setOptions({ fontSize: "11pt", maxLines: Infinity });
4040
editor.session.setMode("ace/mode/r");
4141
42-
import { WebR } from 'https://webr.r-wasm.org/v0.3.2/webr.mjs';
42+
import { WebR } from 'https://webr.r-wasm.org/{{< env WEBR_VERSION_TAG >}}/webr.mjs';
4343
const webR = new WebR();
4444
await webR.init();
4545
await webR.evalRVoid('options(device=webr::canvas)');

‎src/docs/plotting.qmd

+7-6
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ text(4, -4, "זה כתוב בעברית")</div>
8282
editor.setOptions({ fontSize: "11pt", maxLines: Infinity });
8383
editor.session.setMode("ace/mode/r");
8484
85-
import { WebR } from 'https://webr.r-wasm.org/v0.3.2/webr.mjs';
85+
import { WebR } from 'https://webr.r-wasm.org/{{< env WEBR_VERSION_TAG >}}/webr.mjs';
8686
const webR = new WebR();
8787
await webR.init();
8888
await webR.evalRVoid('options(device=function(...){webr::canvas(width=500, height=300)})');
@@ -116,6 +116,7 @@ text(4, -4, "זה כתוב בעברית")</div>
116116
const result = await shelter.captureR(code, {
117117
withAutoprint: true,
118118
captureStreams: true,
119+
captureGraphics: false,
119120
captureConditions: false
120121
});
121122
try {
@@ -149,7 +150,7 @@ In the following fully worked example, multiple plots are handled by listening f
149150
<p>See the JavaScript console for additional output messages.</p>
150151
<div id="plot-container"></div>
151152
<script type="module">
152-
import { WebR } from 'https://webr.r-wasm.org/latest/webr.mjs';
153+
import { WebR } from 'https://webr.r-wasm.org/{{< env WEBR_VERSION_TAG >}}/webr.mjs';
153154
const webR = new WebR();
154155
let canvas = null;
155156
let loading = document.getElementById('loading');
@@ -207,7 +208,7 @@ Click the button below to see the output of this demo,
207208
<button id="plot-button" class="btn btn-success btn-sm" disabled="true">Run graphics demo</button>
208209
<div style="text-align: center" id="plot-container"></div>
209210
<script type="module">
210-
import { WebR } from 'https://webr.r-wasm.org/v0.3.2/webr.mjs';
211+
import { WebR } from 'https://webr.r-wasm.org/{{< env WEBR_VERSION_TAG >}}/webr.mjs';
211212
const webR = new WebR();
212213
let canvas = null;
213214
let container = document.getElementById('plot-container');
@@ -272,7 +273,7 @@ In the following example, a set of demo plots are captured and then displayed on
272273
</div>
273274

274275
<script type="module">
275-
import { WebR } from 'https://webr.r-wasm.org/latest/webr.mjs';
276+
import { WebR } from 'https://webr.r-wasm.org/{{< env WEBR_VERSION_TAG >}}/webr.mjs';
276277
const webR = new WebR();
277278
await webR.init();
278279
@@ -334,7 +335,7 @@ When a new plot is created, the `canvasNewPage` callback is used clearing the bi
334335

335336
<script type="module">
336337
/* Create a webR console using the Console helper class */
337-
import { Console } from 'https://webr.r-wasm.org/latest/webr.mjs';
338+
import { Console } from 'https://webr.r-wasm.org/{{< env WEBR_VERSION_TAG >}}/webr.mjs';
338339
339340
var canvas = document.getElementById("plot-canvas")
340341
var ctx = canvas.getContext('2d');
@@ -420,7 +421,7 @@ In this example, a vector graphics plot is created using the `pdf()` graphics de
420421
<p id="loading">Please wait, webR is working on producing a plot...</div>
421422
<p id="link-container"></p>
422423
<script type="module">
423-
import { WebR } from 'https://webr.r-wasm.org/latest/webr.mjs';
424+
import { WebR } from 'https://webr.r-wasm.org/{{< env WEBR_VERSION_TAG >}}/webr.mjs';
424425
const webR = new WebR();
425426
await webR.init();
426427

‎src/docs/serving.qmd

+5-4
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ The following simple R script will serve files locally from the current working
2525

2626
```{r eval=FALSE}
2727
library(httpuv)
28-
runServer(host = "127.0.0.1", port = 8080,
28+
runServer(
29+
host = "127.0.0.1", port = 8080,
2930
app = list(
3031
staticPaths = list(
3132
"/" = staticPath(
@@ -53,7 +54,7 @@ Interruption of running R code and nested R REPLs (`readline()`, `menu()`, `brow
5354
Enable the `PostMessage` communication channel by explicitly setting [`WebROptions.channelType`](api/js/interfaces/WebR.WebROptions.md#channeltype) during webR initialisation:
5455

5556
``` js
56-
import { WebR, ChannelType } from 'https://webr.r-wasm.org/latest/webr.mjs';
57+
import { WebR, ChannelType } from 'https://webr.r-wasm.org/{{< env WEBR_VERSION_TAG >}}/webr.mjs';
5758
const webR = new WebR({
5859
channelType: ChannelType.PostMessage,
5960
});
@@ -66,15 +67,15 @@ When loading webR from CDN and using the `ServiceWorker` communication channel,
6667
The contents of your worker scripts can simply wrap the workers hosted on the webR CDN. For example, your service worker script may simply contain,
6768

6869
``` javascript
69-
importScripts('https://webr.r-wasm.org/latest/webr-serviceworker.js');
70+
importScripts('https://webr.r-wasm.org/{{< env WEBR_VERSION_TAG >}}/webr-serviceworker.js');
7071
```
7172

7273
saved with the filename `webr-serviceworker.js`.
7374

7475
And your web worker script may simply contain,
7576

7677
``` javascript
77-
importScripts('https://webr.r-wasm.org/latest/webr-worker.js');
78+
importScripts('https://webr.r-wasm.org/{{< env WEBR_VERSION_TAG >}}/webr-worker.js');
7879
```
7980

8081
saved with the filename `webr-worker.js`.

‎src/docs/webr-serviceworker.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
importScripts('https://webr.r-wasm.org/v0.3.2/webr-serviceworker.js');
1+
importScripts('https://webr.r-wasm.org/{{< env WEBR_VERSION_TAG >}}/webr-serviceworker.js');

‎src/docs/webr-worker.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
importScripts('https://webr.r-wasm.org/v0.3.2/webr-worker.js');
1+
importScripts('https://webr.r-wasm.org/{{< env WEBR_VERSION_TAG >}}/webr-worker.js');

‎src/package-lock.json

+23-23
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "webr",
3-
"version": "0.3.2",
3+
"version": "0.3.3-dev",
44
"description": "The statistical programming language R compiled into WASM for use in a web browser and node.",
55
"keywords": [
66
"webR",

‎src/webR/config.ts.in

+1
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@ import { IN_NODE } from './compat';
22

33
export const BASE_URL = IN_NODE ? __dirname + '/' : '@@BASE_URL@@';
44
export const PKG_BASE_URL = '@@PKG_BASE_URL@@';
5+
export const WEBR_VERSION = '@@WEBR_VERSION@@';

‎src/webR/webr-main.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
import { ChannelMain } from './chan/channel';
77
import { newChannelMain, ChannelType } from './chan/channel-common';
88
import { Message } from './chan/message';
9-
import { BASE_URL, PKG_BASE_URL } from './config';
9+
import { BASE_URL, PKG_BASE_URL, WEBR_VERSION } from './config';
1010
import { EmPtr } from './emscripten';
1111
import { WebRPayloadPtr } from './payload';
1212
import { newRProxy, newRClassProxy } from './proxy';
@@ -199,6 +199,7 @@ export class WebR {
199199
#chan: ChannelMain;
200200
#initialised: Promise<unknown>;
201201
globalShelter!: Shelter;
202+
version: string = WEBR_VERSION;
202203

203204
RObject!: ReturnType<typeof newRClassProxy<typeof RWorker.RObject, RObject>>;
204205
RLogical!: ReturnType<typeof newRClassProxy<typeof RWorker.RLogical, RLogical>>;

0 commit comments

Comments
 (0)