Skip to content

Commit dd7d1a5

Browse files
committed
Move foyer package from gh-pages to r-universe.
Distribute foyer package via r-universe. This removes the need to create a custom cran-like repository hosted on github pages. r-universe provides this functionality by linking to a github repository that points to the foyer package (https://github.com/SimpleITK/simpleitk.r-universe.dev).
1 parent 67fd716 commit dd7d1a5

4 files changed

Lines changed: 32 additions & 176 deletions

File tree

.github/workflows/main.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -177,15 +177,15 @@ jobs:
177177
178178
Detailed release notes are available on the [main SimpleITK repository](https://github.com/SimpleITK/SimpleITK/releases/${{ github.ref_name }}).
179179
180-
To install SimpleITK we use a Foyer helper package that downloads the appropriate binary from the GitHub release assets. This is a two step process.
180+
To install SimpleITK we use a Foyer helper package that downloads the appropriate binary. This is a two step process.
181181
182182
To install the latest SimpleITK version to your primary library directory, first element of `.libPaths()`, run the following:
183183
184184
```r
185185
# install the SimpleITK foyer package
186186
install.packages(
187187
"SimpleITK.foyer",
188-
repos = c("https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/"),
188+
repos = c("https://simpleitk.r-universe.dev"),
189189
type = "source"
190190
)
191191
@@ -207,6 +207,7 @@ jobs:
207207
208208
If you directly download the package artifact from this release page, before you install the package you will need to first unzip the file. Then rename it to `SimpleITK_<version>.zip` (windows), `SimpleITK_<version>.tgz` (macOS), or `SimpleITK_<version>.tar.gz` (Linux) to match the expected file name format.
209209
210+
If you need a custom build of SimpleITK or the binary package for your platform, R version, or desired SimpleITK version is not available you will need to build the package yourself. To do this, use the [remotes based installer](https://github.com/SimpleITK/SimpleITKRInstaller).
210211
files: |
211212
release-artifacts/*
212213
fail_on_unmatched_files: true

.github/workflows/update_gh_cran.yml

Lines changed: 0 additions & 45 deletions
This file was deleted.

release_instructions.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Release Instructions
2+
3+
This document describes the steps required to create the binary R release for SimpleITK which updates and relies on the remotes based SimpleITKRInstaller.
4+
5+
1. Create branch off of `main` and switch to it, `git checkout -b updateRelease main`.
6+
7+
1. Update the installer `DESCRIPTION` file: change the `SITK_TARGET` field to the desired SimpleITK version (e.g. v2.5.5) and run the version update script (in bash or Git Bash on windows), `sitk_r_version_date.sh`. This script will update the file's `Version` and `Date` fields according to the `SITK_TARGET`.
8+
9+
1. Commit and push changes:
10+
11+
```
12+
git commit -am "Update SimpleITK release"
13+
git push origin updateRelease
14+
```
15+
16+
1. On GitHub create a PR, see that all tests pass and binary artifacts are created successfuly. Merge into main.
17+
18+
1. Update local `main` from the remote and check out the `main` branch. Tag it using the **exact tag** you listed in the `SITK_TARGET` and push the tag to this repository.
19+
20+
```
21+
git tag v2.5.5
22+
git push https://github.com/SimpleITK/SimpleITKRInstaller.git v2.5.5
23+
```
24+
25+
1. Monitor the build process, https://github.com/SimpleITK/SimpleITKRInstaller/actions. If a build fails due to transient issues, rerun from failed (binary artifacts created for successful builds are retained across reruns).
26+
27+
1. Once all builds complete successfully a [draft release](https://github.com/SimpleITK/SimpleITKRInstaller/releases) is automatically created. Verify that the expected binary packages are available as release artifacts and test them (download, unzip, rename and install).
28+
29+
1. Edit and publish the release. Check that the binary distribution is working as expected via the r-universe distribution of the foyer package (follow the usage instructions provided in the GitHub release notes).

update_cran_repo.R

Lines changed: 0 additions & 129 deletions
This file was deleted.

0 commit comments

Comments
 (0)