Skip to content

Commit

Permalink
docs: update for the new repo structure
Browse files Browse the repository at this point in the history
  • Loading branch information
eitsupi committed Apr 29, 2024
1 parent 7afda5c commit 57ce4c8
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 13 deletions.
15 changes: 5 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,21 +61,17 @@ Check [the Wiki](https://github.com/rocker-org/rocker-versioned2/wiki) for the l

#### Spacial tags for daily builds

There are also special tags that are not listed in the wiki, `devel` and `latest-daily`.
There are also special tags that are not listed in the wiki, `devel`.
The GitHub Actions workflow build and push these images daily.

- The `devel` images are based on `ubuntu:latest` (the latest Ubuntu LTS version) and install [the latest R-devel daily snapshot](https://cloud.r-project.org/src/base-prerelease/).
`devel` tag is vailable for `rocker/r-ver`, `rocker/rstudio`, `rocker/tidyverse`, `rocker/verse`.
- The `latest-daily` tag images are based on `rocker/r-ver:latest` and install [the latest RStudio daily build](https://dailies.rstudio.com/).
`latest-daily` tag is available for `rocker/rstudio`, `rocker/tidyverse`, `rocker/verse`.
pre-built `devel` images are available for `rocker/r-ver`, `rocker/rstudio`, `rocker/tidyverse`, `rocker/verse`.

#### Spacial tags for geospatial toolkit

`rocker/geospatial:ubuntugis` (`rocker/geospatial:X.Y.Z-ubuntugis`) and `rocker/geospatial:dev-osgeo` are special images
that differ slightly from the regular `rocker/geospatial`.
`rocker/geospatial:dev-osgeo` is special image that differ slightly from the regular `rocker/geospatial`.

- `ubuntugis` is built on packages installed from [the ubuntugis-unstable PPA](https://launchpad.net/~ubuntugis/+archive/ubuntu/ubuntugis-unstable).
- `dev-osgeo` is built on the latest release of [PROJ](https://proj.org/), [GDAL](https://gdal.org/), and [GEOS](https://libgeos.org/).
- built on the latest release of [PROJ](https://proj.org/), [GDAL](https://gdal.org/), and [GEOS](https://libgeos.org/).

## Modifying and extending images

Expand Down Expand Up @@ -134,8 +130,7 @@ which is used for R <= 3.6.3 images._
Dockerfiles and docker-bake.json files, which define the pre-built images,
are in [the `dockerfiles` folder](./dockerfiles/) and [the `bakefiles` folder](./bakefiles/).
And,
these files are created from the JSON files under [the `stacks` folder](./stacks/)
by the build scripts under [the `build` folder](./build/).
these files are generated by the build scripts under [the `build` folder](./build/).

When a new version of R or RStudio is released, GitHub Actions will automatically create a Pull Request to update these files.

Expand Down
6 changes: 3 additions & 3 deletions build/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ The wiki HOME(`Home.md`) is generated from `build/reports/wiki_home.Rmd`.

### Stop building a specific R version

Variables described in the stack files that exist in each version may be referenced during document generation.

So, if you no longer need to build a particular R version, please edit the `make-matrix.R` script and exclude that R version from the build matrix, instead of remove the stack file for that version.
If you no longer need to build a particular R version, please edit the `build/scripts/generate-matrix.R` script
and exclude that R version from the build matrix.
Matrix files are reffered to in many places.

### Stop building a specific image of a specific R version

Expand Down

0 comments on commit 57ce4c8

Please sign in to comment.