Skip to content

Commit ea8ea29

Browse files
committed
Add section on viewing the artifact data
1 parent c903509 commit ea8ea29

File tree

4 files changed

+44
-39
lines changed

4 files changed

+44
-39
lines changed

README.md

Lines changed: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,12 @@
1212

1313
Welcome to this tutorial on combining compiling an R package for
1414
[webR](https://docs.r-wasm.org/webr/latest/) and creating a `{pkgdown}`
15-
website using GitHub Actions. In this guide, you will find sample GitHub
16-
Action workflows designed to generate developmental webR/R WASM Package
17-
binaries alongside a `{pkgdown}` website. If you’re eager to streamline
18-
the process of building and deploying your R packages for webR while
19-
also creating a `{pkgdown}` website, you’ve come to the right place.
15+
website using GitHub Actions. In this guide, you will find a sample
16+
GitHub Action workflow designed to generate in one workflow both
17+
developmental webR/R WASM Package binaries alongside a `{pkgdown}`
18+
website. If you’re eager to streamline the process of building and
19+
deploying your R packages for webR while also creating a `{pkgdown}`
20+
website, you’ve come to the right place.
2021

2122
This repository is part of a series exploring three different
2223
approaches:
@@ -56,7 +57,11 @@ approaches:
5657
the deployed content. Explore this repository to understand how this
5758
approach can streamline your R package deployment workflow.
5859

59-
# Overview
60+
Another approach would be to use
61+
[r-universe.dev](https://ropensci.org/blog/2023/11/17/runiverse-wasm/)
62+
to automatically build and supply R WASM package binaries.
63+
64+
## Key Contents
6065

6166
Interested in having your R package automatically be built for
6267
[webR](https://docs.r-wasm.org/webr/latest/) alongside a `{pkgdown}`
@@ -174,15 +179,20 @@ uploaded onto GitHub Pages through an artifact. The artifacts are stored
174179
for 90 days (by default) and can be found under the workflow summary:
175180

176181
1. Click on the **Actions** tab for the repository
177-
2. Select a completed build
178-
3. Press the **Summary** option
179-
4. Under “Artifacts”, click on **github-pages** to download the built
180-
repository
182+
2. Under “All workflows”, select a the **R WASM & {pkgdown} deploy**
183+
3. Choose a completed workflow run
184+
185+
![Example showing how to select a completed
186+
job](man/figures/gh-select-job-for-artifact.png)
181187

182-
![](man/figures/github-actions-webr-repo-github-pages-artifact.png)
188+
4. Under “Artifacts”, click on **github-pages** to download the built R
189+
WASM repository and `{pkgdown}` website or **rwasmrepo** to download
190+
just the built R WASM repository.
183191

184-
**Note:** The size of the `github-pages` deployment is 9.88 MB of
185-
compressed space, while the size of the `rwasmrepo` is only 3.97 MB of
192+
![](man/figures/gh-download-artifact-from-job.png)
193+
194+
**Note:** The size of the `github-pages` deployment is 13.6 MB of
195+
compressed space, while the size of the `rwasmrepo` is only 6.87 MB of
186196
the total compressed space.
187197

188198
## Accessing Binaries
@@ -194,12 +204,6 @@ repository’s GitHub Pages URL, e.g.
194204
https://gh-username.github.io/repo-name
195205
```
196206

197-
Or, using the [r-universe](https://r-universe.dev/search/):
198-
199-
``` default
200-
https://username.r-universe.dev
201-
```
202-
203207
This can be set either using `options()` or specifying the location in
204208
each `webr::install()` call.
205209

@@ -213,7 +217,6 @@ The easiest is probably to define the location webR should search for in
213217
list_of_repos = c(
214218
"https://gh-username.github.io/repo-name",
215219
"https://other-gh-username.github.io/another-repo",
216-
"https://username.r-universe.dev",
217220
"https://repo.r-wasm.org/"
218221
)
219222

README.qmd

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,12 @@ engine: knitr
1313
## Introduction
1414

1515
Welcome to this tutorial on combining compiling an R package for [webR](https://docs.r-wasm.org/webr/latest/) and creating
16-
a `{pkgdown}` website using GitHub Actions. In this guide, you will find sample
17-
GitHub Action workflows designed to generate developmental webR/R WASM Package
18-
binaries alongside a `{pkgdown}` website. If you're eager to streamline the
19-
process of building and deploying your R packages for webR while also creating
20-
a `{pkgdown}` website, you've come to the right place.
16+
a `{pkgdown}` website using GitHub Actions. In this guide, you will find a sample
17+
GitHub Action workflow designed to generate in one workflow both
18+
developmental webR/R WASM Package binaries alongside a `{pkgdown}` website.
19+
If you're eager to streamline the process of building and deploying your R
20+
packages for webR while also creating a `{pkgdown}` website, you've come to the
21+
right place.
2122

2223
This repository is part of a series exploring three different approaches:
2324

@@ -46,7 +47,10 @@ This repository is part of a series exploring three different approaches:
4647
provides a transparent view of the deployed content. Explore this repository
4748
to understand how this approach can streamline your R package deployment workflow.
4849

49-
# Overview
50+
Another approach would be to use [r-universe.dev](https://ropensci.org/blog/2023/11/17/runiverse-wasm/)
51+
to automatically build and supply R WASM package binaries.
52+
53+
## Key Contents
5054

5155
Interested in having your R package automatically be built for [webR](https://docs.r-wasm.org/webr/latest/) alongside a `{pkgdown}` website using a [GitHub Action](https://github.com/features/actions) that deploys with an **artifact** instead of a `gh-pages` branch?
5256
If so, this is the repository for you! Here's a summary of what you can find in the repository:
@@ -149,14 +153,19 @@ onto GitHub Pages through an artifact. The artifacts are stored for 90 days
149153
(by default) and can be found under the workflow summary:
150154

151155
1. Click on the **Actions** tab for the repository
152-
2. Select a completed build
153-
3. Press the **Summary** option
154-
4. Under "Artifacts", click on **github-pages** to download the built repository
156+
2. Under "All workflows", select a the **R WASM & {pkgdown} deploy**
157+
3. Choose a completed workflow run
158+
159+
![Example showing how to select a completed job](man/figures/gh-select-job-for-artifact.png)
155160

156-
![](man/figures/github-actions-webr-repo-github-pages-artifact.png)
161+
4. Under "Artifacts", click on **github-pages** to download the built R WASM repository
162+
and `{pkgdown}` website or **rwasmrepo** to download just the built
163+
R WASM repository.
157164

158-
**Note:** The size of the `github-pages` deployment is 9.88 MB of compressed space,
159-
while the size of the `rwasmrepo` is only 3.97 MB of the total compressed space.
165+
![](man/figures/gh-download-artifact-from-job.png)
166+
167+
**Note:** The size of the `github-pages` deployment is 13.6 MB of compressed space,
168+
while the size of the `rwasmrepo` is only 6.87 MB of the total compressed space.
160169

161170
## Accessing Binaries
162171

@@ -167,12 +176,6 @@ the repository's GitHub Pages URL, e.g.
167176
https://gh-username.github.io/repo-name
168177
```
169178

170-
Or, using the [r-universe](https://r-universe.dev/search/):
171-
172-
```default
173-
https://username.r-universe.dev
174-
```
175-
176179
This can be set either using `options()` or specifying the location in each
177180
`webr::install()` call.
178181

@@ -186,7 +189,6 @@ The easiest is probably to define the location webR should search for in
186189
list_of_repos = c(
187190
"https://gh-username.github.io/repo-name",
188191
"https://other-gh-username.github.io/another-repo",
189-
"https://username.r-universe.dev",
190192
"https://repo.r-wasm.org/"
191193
)
192194

649 KB
Loading
826 KB
Loading

0 commit comments

Comments
 (0)