Skip to content

Commit

Permalink
Merge pull request #599 from Appsilon/release-1.9.0
Browse files Browse the repository at this point in the history
Release 1.9.0
  • Loading branch information
kamilzyla authored Jul 10, 2024
2 parents 7022658 + 1ed056c commit 7b4ef3c
Show file tree
Hide file tree
Showing 5 changed files with 57 additions and 10 deletions.
13 changes: 7 additions & 6 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,7 @@ for the `main` branch should be green).
Do not add a link to GitHub releases yet - the link won't work and will fail CRAN checks.
* Edit the list of changes to make it useful and understandable for our users.
See [keep a changelog](https://keepachangelog.com/) for some guidelines.
5. Update `pkgdown/versions.yml`.
* Add a new version corresponding to the release you are preparing.
6. Submit the changes in a pull request titled "Release X.Y.Z".
5. Submit the changes in a pull request titled "Release X.Y.Z".
Get it approved and merged.

### Submitting to CRAN
Expand Down Expand Up @@ -116,9 +114,12 @@ Use `rc.2`, `rc.3` and so on for subsequent submissions.
4. Check "Set as the latest release".
5. Click "Publish release".
2. Prepare the package for further development.
1. Add a development version `.9000` in `DESCRIPTION`.
2. Add a `# rhino (development version)` header in `NEWS.md`.
3. Link the `# rhino X.Y.Z` header to the GitHub release in `NEWS.md`.
1. Add the new version to `pkgdown/versions.yml`.
2. Add a development version `.9000` in `DESCRIPTION`.
3. Update `NEWS.md`:
* Add a `# rhino (development version)` header.
* Link the `# rhino X.Y.Z` header to the GitHub release.
* Add a link to the migration guide in `NEWS.md`.
3. Announce the release on `#proj-rhino`.

## Development process
Expand Down
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: rhino
Title: A Framework for Enterprise Shiny Applications
Version: 1.8.0.9001
Version: 1.9.0
Authors@R:
c(
person("Kamil", "Żyła", role = c("aut", "cre"), email = "[email protected]"),
Expand Down
5 changes: 2 additions & 3 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# rhino (development version)
# rhino 1.9.0

1. Added `sass: custom` configuration option for cleaner integration with `bslib`.
2. Introduce `format_js()` and `format_sass()` powered by [prettier](https://prettier.io).
* **Migration**: Remove the `.rhino` directory if updating Rhino in an existing project.
2. Introduced `format_js()` and `format_sass()` powered by [prettier](https://prettier.io).
* **Note:** `lint_js()` and `lint_sass()` report styling errors.
They _might_ complain about formatting done with `format_js()` and `format_sass()` functions; however, we haven't spotted any issues so far.
If you face any problems with this, then please [raise an issue on GitHub](https://github.com/Appsilon/rhino/issues/new/choose)
Expand Down
2 changes: 2 additions & 0 deletions pkgdown/_pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,8 @@ navbar:
href: articles/how-to/migrate-1-7.html
- text: Migration to Rhino 1.8
href: articles/how-to/migrate-1-8.html
- text: Migration to Rhino 1.9
href: articles/how-to/migrate-1-9.html

faq:
text: FAQ
Expand Down
45 changes: 45 additions & 0 deletions vignettes/how-to/migrate-1-9.Rmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
title: "How-to: Rhino 1.9 Migration Guide"
output: rmarkdown::html_vignette
vignette: >
%\VignetteIndexEntry{How-to: Rhino 1.9 Migration Guide}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEncoding{UTF-8}
---

Follow the steps outlined in this guide to migrate your project to Rhino 1.9.
Before starting, ensure your Git working tree is clean, or back up your project if not using Git.

This guide assumes you are migrating from Rhino 1.8.
If you are currently using an older version of Rhino,
please review the older migration guides first:

* [Rhino 1.6 Migration Guide](https://appsilon.github.io/rhino/articles/how-to/migrate-1-6.html).
* [Rhino 1.7 Migration Guide](https://appsilon.github.io/rhino/articles/how-to/migrate-1-7.html).
* [Rhino 1.8 Migration Guide](https://appsilon.github.io/rhino/articles/how-to/migrate-1-8.html).

# Step 1: Install Rhino 1.9

Use the following command to install Rhino 1.9 and update your `renv.lock` file:

```r
rhino::pkg_install("[email protected]")
```

After the installation, restart your R session to ensure all changes take effect.

# Step 2: Remove the `.rhino` directory

Remove the `.rhino` directory from the root of your project.
This directory contains Node.js configuration from the previous version of Rhino.

```r
unlink(".rhino", recursive = TRUE)
```

# Step 3: Test your project

Test your project thoroughly to ensure everything works properly after the migration.
If you encounter any issues or have further questions,
don't hesitate to reach out to us via
[GitHub Discussions](https://github.com/Appsilon/rhino/discussions).

0 comments on commit 7b4ef3c

Please sign in to comment.