Skip to content

Commit

Permalink
adapt to new pkgdown v1.4 workflow
Browse files Browse the repository at this point in the history
see: r-lib/pkgdown#1136

and also deploy 📖 from "dev" branch
  • Loading branch information
mrustl committed Sep 9, 2019
1 parent d6514ef commit e1dc6f3
Show file tree
Hide file tree
Showing 7 changed files with 66 additions and 22 deletions.
3 changes: 2 additions & 1 deletion .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@
^README\.md$
^\.httr-oauth$
kwb.orcid.Rproj
^index\.Rmd$
^index\.md$
^.*\.Rproj$
^\.travis\.yml$
16 changes: 14 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
##############################################################################
### Autogenerated with R package kwb.pkgbuild v0.1.1
### (installed from 'Github (kwb-r/kwb.pkgbuild@0ac3694)' source code on 2019-09-06)
### by calling the function kwb.pkgbuild::use_travis()
### (file created at: 2019-09-09 13:14:29)
##############################################################################


language: r
sudo: required
cache: packages
Expand All @@ -11,9 +19,13 @@ matrix:
after_success:
- Rscript -e 'covr::codecov()'
before_deploy:
- Rscript -e 'remotes::install_cran("pkgdown")'
- Rscript -e 'remotes::install_cran("pkgdown")'
deploy:
provider: script
script: Rscript -e 'pkgdown::deploy_site_github(verbose = TRUE)'
skip_cleanup: true
skip_cleanup: 'true'
on:
branch:
- master
- dev
- r: oldrel
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# MIT License

Copyright (c) 2018 Kompetenzzentrum Wasser Berlin gGmbH (KWB)
Copyright (c) 2018-2019 Kompetenzzentrum Wasser Berlin gGmbH (KWB)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# MIT License

Copyright (c) 2018 Kompetenzzentrum Wasser Berlin gGmbH (KWB)
Copyright (c) 2018-2019 Kompetenzzentrum Wasser Berlin gGmbH (KWB)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,27 @@

# kwb.orcid

R package for checking ORCID use at KWB. It is a wrapper for the
R package [rorcid](https://github.com/ropensci/rorcid).
R package for checking ORCID use at KWB. It is a wrapper for the R package [rorcid](https://github.com/ropensci/rorcid).


## Installation

```r
### Optionally: specify GitHub Personal Access Token (GITHUB_PAT)"
### See here why this might be important for you:"
### https://kwb-r.github.io/kwb.pkgbuild/articles/install.html#set-your-github_pat"

# Sys.setenv(GITHUB_PAT = \"mysecret_access_token\")"

# Install package \"remotes\" from CRAN"
"if (! require(\"remotes\")) {"
install.packages(\"remotes\", repos = \"https://cloud.r-project.org\")"
}

# Install KWB package 'kwb.orcid' from GitHub"

remotes::install_github("kwb-r/kwb.orcid")
```

## Documentation

Expand Down
15 changes: 0 additions & 15 deletions index.Rmd

This file was deleted.

27 changes: 27 additions & 0 deletions index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
[![Appveyor build Status](https://ci.appveyor.com/api/projects/status/nu9yrfk4kwut60f7/branch/master?svg=true)](https://ci.appveyor.com/project/KWB-R/kwb-orcid/branch/master)
[![Travis build Status](https://travis-ci.org/KWB-R/kwb.orcid.svg?branch=master)](https://travis-ci.org/KWB-R/kwb.orcid)
[![codecov](https://codecov.io/github/KWB-R/kwb.orcid/branch/master/graphs/badge.svg)](https://codecov.io/github/KWB-R/kwb.orcid)
[![Project Status](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/kwb.orcid)]()

R package for checking ORCID use at KWB. It is a wrapper for the
R package [rorcid](https://github.com/ropensci/rorcid).

## Installation

```r
### Optionally: specify GitHub Personal Access Token (GITHUB_PAT)"
### See here why this might be important for you:"
### https://kwb-r.github.io/kwb.pkgbuild/articles/install.html#set-your-github_pat"

# Sys.setenv(GITHUB_PAT = \"mysecret_access_token\")"

# Install package \"remotes\" from CRAN"
"if (! require(\"remotes\")) {"
install.packages(\"remotes\", repos = \"https://cloud.r-project.org\")"
}

# Install KWB package 'kwb.orcid' from GitHub"

remotes::install_github("kwb-r/kwb.orcid")
```

0 comments on commit e1dc6f3

Please sign in to comment.