v0.10.1 (#332)

* test run revdep. all pass * bump version to 0.10.1 * move deploy workflow into check workflow and need all checks to pass first * Fix broken link * Run revdepcheck() * do not make testthat a required test package * update cran comments * document ./docs * make sure it is a push event. (Only master or ghactions from above definition)
rstudio · Feb 13, 2020 · 56576af · 56576af
1 parent 89c1d14
commit 56576af
Show file tree

Hide file tree

Showing 14 changed files with 112 additions and 101 deletions.
diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml
@@ -87,3 +87,63 @@ jobs:
         run: >
           Rscript
           -e 'covr::codecov(token = "${{secrets.CODECOV_TOKEN}}")'
+
+
+
+
+  deploy:
+    if: github.repository == 'rstudio/learnr' && github.event_name == 'push'
+    runs-on: ${{ matrix.config.os }}
+
+    name: "Deploy to shinyapps.io"
+    needs: [R-CMD-check]
+
+    strategy:
+      fail-fast: false
+      matrix:
+        config:
+          - {os: ubuntu-16.04, r: '3.6', cran: "https://demo.rstudiopm.com/all/__linux__/xenial/latest"}
+
+    env:
+      R_REMOTES_NO_ERRORS_FROM_WARNINGS: true
+      CRAN: ${{ matrix.config.cran }}
+
+    steps:
+      - uses: actions/checkout@v1
+
+      - uses: r-lib/actions/setup-r@master
+        with:
+          r-version: ${{ matrix.config.r }}
+
+      - uses: r-lib/actions/setup-pandoc@master
+
+      - name: Query dependencies
+        run: >
+          Rscript
+          -e "install.packages('remotes')"
+          -e "saveRDS(remotes::dev_package_deps(dependencies = TRUE), 'depends.Rds', version = 2)"
+
+      - name: Cache R packages
+        if: runner.os != 'Windows'
+        uses: actions/cache@v1
+        with:
+          path: ${{ env.R_LIBS_USER }}
+          key: ${{ runner.os }}-r-${{ matrix.config.r }}-deploy-${{ hashFiles('depends.Rds') }}
+          restore-keys: |
+            ${{ runner.os }}-r-${{ matrix.config.r }}-deploy-
+            ${{ runner.os }}-r-${{ matrix.config.r }}-
+
+      - name: Install dependencies
+        run: >
+          Rscript
+          -e "library(remotes)"
+          -e "update(readRDS('depends.Rds'))"
+          -e "remotes::install_cran('sortable')"
+
+      - name: Deploy
+        env:
+          SHINYAPPS_NAME: ${{ secrets.SHINYAPPS_NAME }}
+          SHINYAPPS_TOKEN: ${{ secrets.SHINYAPPS_TOKEN }}
+          SHINYAPPS_SECRET: ${{ secrets.SHINYAPPS_SECRET }}
+        run: >
+          Rscript 'tools/deploy_tutorials_on_ci.R'
diff --git a/.github/workflows/deploy.yaml b/.github/workflows/deploy.yaml
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,7 +1,7 @@
 Package: learnr
 Type: Package
 Title: Interactive Tutorials for R
-Version: 0.10.0.9000
+Version: 0.10.1
 Authors@R: c(
   person("Barret", "Schloerke", role = c("aut", "cre"), email = "[email protected]",
         comment = c(ORCID = "0000-0001-9986-114X")),

diff --git a/NEWS.md b/NEWS.md
@@ -1,4 +1,4 @@
-learnr 0.10.0.9000 (unreleased)
+learnr 0.10.1
 ===========
 
 ## New features
@@ -19,7 +19,7 @@ learnr 0.10.0.9000 (unreleased)
 
 * Fixed extra parameter documentation bug for CRAN. ([#323](https://github.com/rstudio/learnr/pull/323))
 
-* Fixed video initialization error caused by a jQuery version increase in Shiny. ([#326](https://github.com/rstudio/learnr/pull/#326))
+* Fixed video initialization error caused by a jQuery version increase in Shiny. ([#326](https://github.com/rstudio/learnr/pull/326))
 
 * Fixed progressive reveal bug where the next section would not be displayed unless refreshed. ([#330](https://github.com/rstudio/learnr/pull/330))
 

diff --git a/cran-comments.md b/cran-comments.md
@@ -1,21 +1,41 @@
 
 ## Comments
-### 2019-11-08
+### 2020-02-12
+
+I have addressed the extra parameter documentation and made other improvements to learnr.
 
 Please let me know if there is anything I can do.
 
 Thank you,
 Barret
 
+### 2020-02-03
+
+Specifically, see the warnings about 'Documented arguments not in
+\usage' in the r-devel checks.  These are from a recent bug fix
+(PR#16223, see
+<https://bugs.r-project.org/bugzilla/show_bug.cgi?id=16223>): can you
+please fix your man pages as necessary?  (In most cases, remove the
+documentation for argument '...'.)
+
+Please correct before 2020-02-17 to safely retain your package on CRAN.
+
+Best,
+-k
+
 
 ## Test environments
 * local OS X install, R 3.6.1
-* ubuntu 14.04 (on travis-ci), release, oldrel, devel
-* win-builder (oldrelease, release, devel)
-* R-hub windows-x86_64-release (r-release)
-* R-hub windows-x86_64-devel (r-devel)
-* R-hub ubuntu-gcc-release (r-release)
-* R-hub fedora-clang-devel (r-devel)
+* GitHub Actions
+  * ubuntu 16.04 - R 3.2, 3.3, 3.4, 3.5, 3.6.2
+  * mac - 3.6.2
+  * windows - 3.6.2, devel
+* win-builder (oldrelease, release)
+* R-hub - Windows Server 2008 R2 SP1, R-devel, 32/64 bit (devel)
+
+I did not get an email response from win-builder devel.
+
+
 
 ## R CMD check results
 

diff --git a/docs/examples.html b/docs/examples.html
@@ -13,7 +13,7 @@
 
 <title>Examples</title>
 
-<script src="site_libs/header-attrs-2.1.1/header-attrs.js"></script>
+<script src="site_libs/header-attrs-2.1/header-attrs.js"></script>
 <script src="site_libs/jquery-1.11.3/jquery.min.js"></script>
 <meta name="viewport" content="width=device-width, initial-scale=1" />
 <link href="site_libs/bootstrap-3.3.5/css/cosmo.min.css" rel="stylesheet" />

diff --git a/docs/exercises.html b/docs/exercises.html
@@ -13,7 +13,7 @@
 
 <title>Exercises</title>
 
-<script src="site_libs/header-attrs-2.1.1/header-attrs.js"></script>
+<script src="site_libs/header-attrs-2.1/header-attrs.js"></script>
 <script src="site_libs/jquery-1.11.3/jquery.min.js"></script>
 <meta name="viewport" content="width=device-width, initial-scale=1" />
 <link href="site_libs/bootstrap-3.3.5/css/cosmo.min.css" rel="stylesheet" />

diff --git a/docs/formats.html b/docs/formats.html
@@ -13,7 +13,7 @@
 
 <title>Formats</title>
 
-<script src="site_libs/header-attrs-2.1.1/header-attrs.js"></script>
+<script src="site_libs/header-attrs-2.1/header-attrs.js"></script>
 <script src="site_libs/jquery-1.11.3/jquery.min.js"></script>
 <meta name="viewport" content="width=device-width, initial-scale=1" />
 <link href="site_libs/bootstrap-3.3.5/css/cosmo.min.css" rel="stylesheet" />

diff --git a/docs/index.html b/docs/index.html
@@ -13,7 +13,7 @@
 
 <title>Interactive Tutorials for R</title>
 
-<script src="site_libs/header-attrs-2.1.1/header-attrs.js"></script>
+<script src="site_libs/header-attrs-2.1/header-attrs.js"></script>
 <script src="site_libs/jquery-1.11.3/jquery.min.js"></script>
 <meta name="viewport" content="width=device-width, initial-scale=1" />
 <link href="site_libs/bootstrap-3.3.5/css/cosmo.min.css" rel="stylesheet" />
@@ -497,9 +497,10 @@ <h3>Installation</h3>
 <h3>Creating a Tutorial</h3>
 <p>A tutorial is just a directory that contains a standard R Markdown document with three additional attributes:</p>
 <ol style="list-style-type: decimal">
-<li>Loads the <strong>learnr</strong> package.</li>
-<li>Includes one or more interactive components (exercises, quiz questions, etc.).</li>
-<li>Uses the <code>runtime: shiny_prerendered</code> directive in the YAML header.</li>
+<li>Loads the <strong>learnr</strong> package,</li>
+<li>Includes one or more interactive components (exercises, quiz questions, etc.),</li>
+<li>Uses the <code>runtime: shiny_prerendered</code> directive in the YAML header,</li>
+<li>Provides a short description in the top-level <code>description:</code> field of the YAML header.</li>
 </ol>
 <p>The <code>runtime: shiny_prerendered</code> element included in the YAML hints at the underlying implementation of tutorials: they are simply Shiny applications which use an R Markdown document as their user-interface rather than the traditional <code>ui.R</code> file.</p>
 <div id="tutorial-format" class="section level4">

diff --git a/docs/publishing.html b/docs/publishing.html
@@ -13,6 +13,7 @@
 
 <title>Publishing</title>
 
+<script src="site_libs/header-attrs-2.1/header-attrs.js"></script>
 <script src="site_libs/jquery-1.11.3/jquery.min.js"></script>
 <meta name="viewport" content="width=device-width, initial-scale=1" />
 <link href="site_libs/bootstrap-3.3.5/css/cosmo.min.css" rel="stylesheet" />
@@ -424,7 +425,7 @@ <h2>R Package</h2>
 <pre class="r"><code>install.packages(&quot;learnr&quot;)
 learnr::run_tutorial(&quot;introduction&quot;, package = &quot;mypackage&quot;)</code></pre>
 <div id="exercise-checkers" class="section level3 toc-ignore">
-<h3>Exercise Checkers</h3>
+<h3 class="toc-ignore">Exercise Checkers</h3>
 <p>Note that if your tutorial performs <a href="exercises.html#checking-exercises">exercise checking</a> via an external package then you should be sure to add the package you use for checking as an <code>Imports</code> dependency of your package so it’s installed automatically along with your package.</p>
 <p>Note that it’s likely that the <strong>learnr</strong> package will eventually include or depend on another package that provides checking functions. For the time being though explicit installation of external checking packages is a requirement.</p>
 </div>

diff --git a/docs/questions.html b/docs/questions.html
@@ -13,7 +13,7 @@
 
 <title>Questions</title>
 
-<script src="site_libs/header-attrs-2.1.1/header-attrs.js"></script>
+<script src="site_libs/header-attrs-2.1/header-attrs.js"></script>
 <script src="site_libs/jquery-1.11.3/jquery.min.js"></script>
 <meta name="viewport" content="width=device-width, initial-scale=1" />
 <link href="site_libs/bootstrap-3.3.5/css/cosmo.min.css" rel="stylesheet" />

diff --git a/...e_libs/header-attrs-2.1.1/header-attrs.js → ...ite_libs/header-attrs-2.1/header-attrs.js b/...e_libs/header-attrs-2.1.1/header-attrs.js → ...ite_libs/header-attrs-2.1/header-attrs.js
diff --git a/revdep/README.md b/revdep/README.md
@@ -3,21 +3,20 @@
 |field    |value                        |
 |:--------|:----------------------------|
 |version  |R version 3.6.1 (2019-07-05) |
-|os       |macOS Mojave 10.14.6         |
+|os       |macOS Catalina 10.15.2       |
 |system   |x86_64, darwin15.6.0         |
 |ui       |X11                          |
 |language |(EN)                         |
 |collate  |en_US.UTF-8                  |
 |ctype    |en_US.UTF-8                  |
 |tz       |America/New_York             |
-|date     |2019-11-08                   |
+|date     |2020-02-12                   |
 
 # Dependencies
 
-|package |old     |new    |Δ  |
-|:-------|:-------|:------|:--|
-|learnr  |0.9.2.1 |0.10.0 |*  |
-|Rcpp    |NA      |1.0.2  |*  |
+|package |old    |new    |Δ  |
+|:-------|:------|:------|:--|
+|learnr  |0.10.0 |0.10.1 |*  |
 
 # Revdeps
 
diff --git a/tests/testthat.R b/tests/testthat.R
@@ -1,4 +1,7 @@
-library(testthat)
-library(learnr)
 
-test_check("learnr")
+if (requireNamespace("testthat")) {
+  library(testthat)
+  library(learnr)
+
+  test_check("learnr")
+}