Fix Build and push to GHCR step

Author: bschilder

.Rhistory

@@ -1,3 +1,14 @@
+# rworkflows 1.0.1
+
+## New features
+
+- Change command "\nodocker" to "[nodocker]" for consistency with other commands.
+
+## Bug fixes
+
+- *action.yml* 
+  - `repository: ${{ github.repository }}` --> `repository: ${{ env.packageName }}`
+
 # rworkflows 1.0.0
 
 ## New features
@@ -15,6 +26,7 @@ Release versioning.
     the vignette is being rendered.
 * *use_vignette_docker*
   - Add *-autolink_bare_uris* bit to avoid CRAN check errors.
+* Change `\itemize` --> `describe` to avoid CRAN check errors.
 
 # rworkflows 0.99.14
 

NEWS.md

@@ -4,7 +4,7 @@
 #' \href{https://bioconductor.org/}{Bioconductor}.
 #' @param bioc_version Version of Bioc to return info for.
 #' Can be:
-#' \itemize{
+#' \describe{
 #' \item{"devel"}{Get the current development version of Bioc.}
 #' \item{"release"}{Get the current release version of Bioc.}
 #' \item{<numeric>}{A specific Bioc version number (e.g. \code{3.16}).}
@@ -13,7 +13,7 @@
 #' @param depth How many levels deep into the R version to include.
 #' For example, is the R version number is "4.2.0", 
 #' the following depths would return:
-#' \itemize{
+#' \describe{
 #' \item{\code{depth=NULL}: }{"4.2.0"}
 #' \item{\code{depth=1}: }{"4"}
 #' \item{\code{depth=2}: }{"4.2"}

R/bioc_r_versions.R

@@ -2,7 +2,6 @@
 #' 
 #' Check that a list of containers are valid.
 #' @inheritParams construct_runners
-#' @param domain Container repository API domain.
 #' @returns Null
 #' 
 #' @keywords internal 

R/check_cont.R

@@ -4,7 +4,7 @@
 #' (and the tag, if specified) exist using \link[rworkflows]{check_cont}.
 #' @param default_registry The default container registry to use.
 #' Options include:
-#' \itemize{
+#' \describe{
 #'  \item{"ghcr.io/" : }{\href{https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry}{GitHub Container Registry}}
 #'  \item{"docker.io/" : }{\href{https://hub.docker.com/}{DockerHub}}
 #'  \item{"mcr.microsoft.com/" : }{\href{https://github.com/microsoft/ContainerRegistry}{Microsoft Container Registry}}

R/construct_cont.R

@@ -6,7 +6,7 @@
 #' R package template. 
 #' For any given field, set its corresponding argument as follows 
 #' to get certain behaviour:
-#' \itemize{
+#' \describe{
 #' \item{\code{NULL}: }{Keeps the current value.}
 #' \item{\code{NA}: }{Removes the field from the 
 #' \emph{DESCRIPTION} file entirely.}

R/fill_description.R

@@ -4,7 +4,7 @@
 #' \href{https://github.com/neurogenomics/rworkflows}{rworkflows}
 #' \href{https://github.com/features/actions}{GitHub Actions (GHA)}  
 #' @param template Workflow template name.
-#' \itemize{
+#' \describe{
 #' \item{"rworkflows"}{A short workflow script that calls
 #'  the GitHub action from the GitHub Marketplace.
 #' The action is continually updated 
@@ -71,10 +71,10 @@
 #' @param run_docker Whether to build and push a Docker container to DockerHub.
 #' @param docker_registry Docker container registry to push to. 
 #' Options include:
-#' \itemize{
-#'  \item{"ghcr.io"} : \href{https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry}{
-#'  GitHub Container Registry}
-#'  \item{"docker.io"} : \href{https://hub.docker.com/}{DockerHub} 
+#' \describe{
+#'  \item{"ghcr.io" : }{\href{https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry}{
+#'  GitHub Container Registry}}  
+#'  \item{"docker.io" : }{\href{https://hub.docker.com/}{DockerHub}}
 #' }
 #' @param docker_user Docker registry username.
 #' Not used when \code{docker_registry="ghcr.io"}.

R/use_workflow.R

@@ -50,7 +50,7 @@ and/or [**Bioconductor**](https://bioconductor.org/) checks).
 to [**Codecov**](https://about.codecov.io/).  
 9. 🚀 (Re)builds and launches a documentation website for your R package.  
 10. 🐳 Pushes a [**Docker**](https://www.docker.com/) container (with [**Rstudio**](https://posit.co/) and all dependencies pre-installed) to 
-your choice of container registry (e.g. [GitHub Container Registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry),  [**DockerHub**](https://hub.docker.com/)). 
+your choice of container registry (e.g. [**GitHub Container Registry**](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry),  [**DockerHub**](https://hub.docker.com/)). 
 11. 🔭 Generates [workflow telemetry](https://github.com/runforesight/workflow-telemetry-action) report.  
 12. 🎖 Updates relevant badges added to your README 
 with `rworkflows::use_badges()`.

README.Rmd

@@ -24,7 +24,7 @@ status](https://github.com/neurogenomics/rworkflows/workflows/rworkflows_dev/bad
 Authors: <i>Brian Schilder, Alan Murphy, Nathan Skene</i>  
 </h4>
 <h4>  
-README updated: <i>Nov-01-2023</i>  
+README updated: <i>Nov-02-2023</i>  
 </h4>
 
 ## Intro
@@ -79,8 +79,8 @@ options to enable/disable/modify each step):
     package.  
 10. 🐳 Pushes a [**Docker**](https://www.docker.com/) container (with
     [**Rstudio**](https://posit.co/) and all dependencies pre-installed)
-    to your choice of container registry (e.g. [GitHub Container
-    Registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry),
+    to your choice of container registry (e.g. [**GitHub Container
+    Registry**](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry),
     [**DockerHub**](https://hub.docker.com/)).
 11. 🔭 Generates [workflow
     telemetry](https://github.com/runforesight/workflow-telemetry-action)

README.md

@@ -502,7 +502,7 @@ runs:
     ## DockerHub steps
     - name: 🐳✏️ Create Docker file 
       if: |
-        (!contains(github.event.head_commit.message, '/nodocker')) && inputs.run_docker == 'true' && runner.os == 'Linux'
+        (!contains(github.event.head_commit.message, '[nodocker]')) && inputs.run_docker == 'true' && runner.os == 'Linux'
       env:
         BASE_IMAGE: ${{ matrix.config.cont }}
         GITHUB_TOKEN: ${{ inputs.GITHUB_TOKEN }}
@@ -514,15 +514,15 @@ runs:
 
     - name: 🐳🚀 Build and push to GHCR 
       if: |
-        (!contains(github.event.head_commit.message, '/nodocker')) && inputs.run_docker == 'true' && runner.os == 'Linux' && inputs.docker_registry == 'ghcr.io'
+        (!contains(github.event.head_commit.message, '[nodocker]')) && inputs.run_docker == 'true' && runner.os == 'Linux' && inputs.docker_registry == 'ghcr.io'
       uses: docker/build-push-action@v1
       env: 
         GITHUB_TOKEN: ${{ inputs.GITHUB_TOKEN }}
       with:
         username: ${{ github.repository_owner }}
         password: ${{ inputs.GITHUB_TOKEN }}
         registry: ${{ inputs.docker_registry }}
-        repository: ${{ github.repository }}
+        repository: ${{ github.repository_owner }}/${{ env.packageName }}
         tag_with_ref: true
         tag_with_sha: false
         tags: |
@@ -534,7 +534,7 @@ runs:
           
     - name: 🐳🚀 Build and push to DockerHub 
       if: |
-        (!contains(github.event.head_commit.message, '/nodocker')) && inputs.run_docker == 'true' && runner.os == 'Linux' && inputs.docker_registry == 'docker.io'
+        (!contains(github.event.head_commit.message, '[nodocker]')) && inputs.run_docker == 'true' && runner.os == 'Linux' && inputs.docker_registry == 'docker.io'
       uses: docker/build-push-action@v1
       env: 
         GITHUB_TOKEN: ${{ inputs.GITHUB_TOKEN }}