Skip to content

Commit 6c82d94

Browse files
committed
Update README to reflect changes related to action deployment.
1 parent 85be2aa commit 6c82d94

File tree

2 files changed

+18
-17
lines changed

2 files changed

+18
-17
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -67,14 +67,6 @@ quarto add coatless-quarto/panelize
6767
mv _extensions altdoc/_extensions
6868
```
6969

70-
> [!IMPORTANT]
71-
>
72-
> The version of `{quarto-webr}` differs from the main repository
73-
> slightly to put the version of webR on the `latest` version instead of
74-
> `v0.3.3` as the [`{rwasm}`](https://github.com/r-wasm/rwasm) package
75-
> used to compile binaries is now obtaining one for R v4.4.0 instead of
76-
> R v4.3.3.
77-
7870
### Step 3: Add a pre-render step to `quarto_website.yaml` file
7971

8072
1. Add a [`pre-render`
@@ -188,7 +180,8 @@ jobs:
188180
with:
189181
packages: "."
190182
repo-path: "_site"
191-
183+
webr-image: "ghcr.io/r-wasm/webr:v0.3.3" # fixed version for now
184+
192185
# Upload the CRAN repository for use in the next step
193186
# Make sure to set a retention day to avoid running into a cap
194187
- name: Upload build artifact
@@ -272,6 +265,13 @@ You can view the full workflow file here:
272265
273266
<https://github.com/coatless-r-n-d/quarto-webr-in-altdoc/blob/main/.github/workflows/altdoc.yaml>
274267
268+
> [!IMPORTANT]
269+
>
270+
> We’ve fixed the version of webR being used to generate the R WASM
271+
> binaries to `v0.3.3` for the `webr-image` in the `rwasmbuild` job.
272+
> This is to ensure that a released/tagged version of webR is used
273+
> instead of depending on the latest release, e.g. `latest` tag.
274+
275275
### Step 8: Enable GitHub Pages
276276

277277
Enabling GitHub Pages on the repository by following:

README.qmd

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -52,13 +52,6 @@ quarto add coatless-quarto/panelize
5252
mv _extensions altdoc/_extensions
5353
```
5454

55-
:::{.callout-important}
56-
The version of `{quarto-webr}` differs from the main repository slightly to
57-
put the version of webR on the `latest` version instead of `v0.3.3` as the
58-
[`{rwasm}`](https://github.com/r-wasm/rwasm) package used to compile binaries is
59-
now obtaining one for R v4.4.0 instead of R v4.3.3.
60-
:::
61-
6255
### Step 3: Add a pre-render step to `quarto_website.yaml` file
6356

6457
1. Add a [`pre-render` step](https://quarto.org/docs/projects/scripts.html#pre-and-post-render) into the
@@ -165,7 +158,8 @@ jobs:
165158
with:
166159
packages: "."
167160
repo-path: "_site"
168-
161+
webr-image: "ghcr.io/r-wasm/webr:v0.3.3" # fixed version for now
162+
169163
# Upload the CRAN repository for use in the next step
170164
# Make sure to set a retention day to avoid running into a cap
171165
- name: Upload build artifact
@@ -249,6 +243,13 @@ You can view the full workflow file here:
249243
250244
<https://github.com/coatless-r-n-d/quarto-webr-in-altdoc/blob/main/.github/workflows/altdoc.yaml>
251245
246+
:::{.callout-important}
247+
We've fixed the version of webR being used to generate the R WASM binaries
248+
to `v0.3.3` for the `webr-image` in the `rwasmbuild` job. This is to
249+
ensure that a released/tagged version of webR is used instead of depending
250+
on the latest release, e.g. `latest` tag.
251+
:::
252+
252253
### Step 8: Enable GitHub Pages
253254

254255
Enabling GitHub Pages on the repository by following:

0 commit comments

Comments
 (0)