Newline in Description causes an error

[muschellij2]

If \n in description argument of posting new repo, you get an error.

Creating a repo

library(gh)
repo_name = basename(tempfile())
create <- gh::gh(
  "POST /user/repos",
  name = repo_name,
  description = ""
)
Sys.sleep(2)
del <- gh::gh(
  "DELETE /repos/:owner/:repo",
  repo = repo_name,
  owner = "muschellij2")

Creating repo with newline in description:

repo_desc = "title with \n newline"
create <- gh::gh(
  "POST /user/repos",
  name = repo_name,
  description = repo_desc
)
#> Error in gh::gh("POST /user/repos", name = repo_name, description = repo_desc): GitHub API error (422): 422 Unprocessable Entity
#>   Repository creation failed.


sessioninfo::session_info()
#> ─ Session info ──────────────────────────────────────────────────────────
#>  setting  value                       
#>  version  R version 3.5.2 (2018-12-20)
#>  os       macOS Sierra 10.12.6        
#>  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-01-23                  
#> 
#> ─ Packages ──────────────────────────────────────────────────────────────
#>  package     * version date       lib source        
#>  assertthat    0.2.0   2017-04-11 [1] CRAN (R 3.5.0)
#>  cli           1.0.1   2018-09-25 [1] CRAN (R 3.5.0)
#>  crayon        1.3.4   2017-09-16 [1] CRAN (R 3.5.0)
#>  curl          3.3     2019-01-10 [1] CRAN (R 3.5.2)
#>  digest        0.6.18  2018-10-10 [1] CRAN (R 3.5.0)
#>  evaluate      0.12    2018-10-09 [1] CRAN (R 3.5.0)
#>  gh          * 1.0.1   2017-07-16 [1] CRAN (R 3.5.0)
#>  highr         0.7     2018-06-09 [1] CRAN (R 3.5.0)
#>  htmltools     0.3.6   2017-04-28 [1] CRAN (R 3.5.0)
#>  httr          1.4.0   2018-12-11 [1] CRAN (R 3.5.0)
#>  jsonlite      1.6     2018-12-07 [1] CRAN (R 3.5.0)
#>  knitr         1.21    2018-12-10 [1] CRAN (R 3.5.2)
#>  magrittr      1.5     2014-11-22 [1] CRAN (R 3.5.0)
#>  R6            2.3.0   2018-10-04 [1] CRAN (R 3.5.0)
#>  Rcpp          1.0.0   2018-11-07 [1] CRAN (R 3.5.0)
#>  rmarkdown     1.11    2018-12-08 [1] CRAN (R 3.5.0)
#>  sessioninfo   1.1.1   2018-11-05 [1] CRAN (R 3.5.0)
#>  stringi       1.2.4   2018-07-20 [1] CRAN (R 3.5.0)
#>  stringr       1.3.1   2018-05-10 [1] CRAN (R 3.5.0)
#>  withr         2.1.2   2018-03-15 [1] CRAN (R 3.5.0)
#>  xfun          0.4     2018-10-23 [1] CRAN (R 3.5.0)
#>  yaml          2.2.0   2018-07-25 [1] CRAN (R 3.5.0)
#> 
#> [1] /Library/Frameworks/R.framework/Versions/3.5/Resources/library

^{Created on 2019-01-23 by the reprex package (v0.2.1)}

[gaborcsardi]

GitHub does not allow newlines in the repo description AFAICT, so this is not a restriction.

[muschellij2]

I agree with you, but this is an error if you try to push

On Tue, Jan 21, 2020 at 9:19 AM Gábor Csárdi ***@***.***> wrote: Closed #92 <#92>. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#92?email_source=notifications&email_token=AAIGPLSC2ALWSVNEFRZBXR3Q6376VA5CNFSM4GR7HRKKYY3PNVWWK3TUL52HS4DFWZEXG43VMVCXMZLOORHG65DJMZUWGYLUNFXW5KTDN5WW2ZLOORPWSZGOWDHUSYI#event-2966374753>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAIGPLSKMC72N2LYERWYZU3Q6376VANCNFSM4GR7HRKA> .

-- Best, John

[gaborcsardi]

Push what?

[muschellij2]

I have to check (on mobile right now) But this causes an issue when you try to push your repository to a GH repo when using usethis::use_github. It’s been a while but I think this may have been the root of the problem

On Tue, Jan 21, 2020 at 9:39 AM Gábor Csárdi ***@***.***> wrote: Push what? — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#92?email_source=notifications&email_token=AAIGPLWBG67PKAHCSNHZA6TQ64CKRA5CNFSM4GR7HRKKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEJP6UEA#issuecomment-576711184>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAIGPLRSPGW2XMTBUACZQTTQ64CKRANCNFSM4GR7HRKA> .

-- Best, John

[gaborcsardi]

In that case I would say that it is a usethis bug, and usethis needs to sanitize the package title, by removing the newline characters.

gh is dump and does not know anything about GH API endpoints, so it cannot do this for you automatically.

[muschellij2]

I agree, but thought you’d want to sanitize inputs in gh itself as well. If not, ok with a close

On Tue, Jan 21, 2020 at 9:48 AM Gábor Csárdi ***@***.***> wrote: In that case I would say that it is a usethis bug, and usethis needs to sanitize the package title, by removing the newline characters. gh is dump and does not know anything about GH API endpoints, so it cannot do this for you automatically. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#92?email_source=notifications&email_token=AAIGPLRZYXP7VB3PUTY6I5DQ64DNPA5CNFSM4GR7HRKKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEJP7VQI#issuecomment-576715457>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAIGPLS3HSGPHWG5OZ3PDG3Q64DNPANCNFSM4GR7HRKA> .

-- Best, John

[gaborcsardi]

gh cannot sanitize this, because it does not know what it is for and whether newlines are allowed or not. usethis knows that it is the repo description, so it can sanitize it.

[muschellij2]

OK - will do. I had added https://github.com/r-lib/usethis/blob/master/R/github.R#L59 in the past and I think this resolves this.

[gaborcsardi]

Yeah, that should solve it.