Commitab0b7e9

authored

Merge pull request#41 from r-lib/pkgdown

Set up an `r-lib`-style pkgdown site

2 parentsfdde7ec +8708448 commitab0b7e9Copy full SHA for ab0b7e9

File tree

+80

-1

lines changed

+80

-1

lines changed

Lines changed: 3 additions & 0 deletions

Lines changed: 50 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,50 @@`
	`1`	`+# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples`
	`2`	`+# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help`
	`3`	`+on:`
	`4`	`+push:`
	`5`	`+branches:[main, master]`
	`6`	`+pull_request:`
	`7`	`+branches:[main, master]`
	`8`	`+release:`
	`9`	`+types:[published]`
	`10`	`+workflow_dispatch:`
	`11`	`+`
	`12`	`+name:pkgdown.yaml`
	`13`	`+`
	`14`	`+permissions:read-all`
	`15`	`+`
	`16`	`+jobs:`
	`17`	`+pkgdown:`
	`18`	`+runs-on:ubuntu-latest`
	`19`	`+# Only restrict concurrency for non-PR jobs`
	`20`	`+concurrency:`
	`21`	`+group:pkgdown-${{ github.event_name != 'pull_request' \|\| github.run_id }}`
	`22`	`+env:`
	`23`	`+GITHUB_PAT:${{ secrets.GITHUB_TOKEN }}`
	`24`	`+permissions:`
	`25`	`+contents:write`
	`26`	`+steps:`
	`27`	`+ -uses:actions/checkout@v4`
	`28`	`+`
	`29`	`+ -uses:r-lib/actions/setup-pandoc@v2`
	`30`	`+`
	`31`	`+ -uses:r-lib/actions/setup-r@v2`
	`32`	`+with:`
	`33`	`+use-public-rspm:true`
	`34`	`+`
	`35`	`+ -uses:r-lib/actions/setup-r-dependencies@v2`
	`36`	`+with:`
	`37`	`+extra-packages:any::pkgdown, local::.`
	`38`	`+needs:website`
	`39`	`+`
	`40`	`+ -name:Build site`
	`41`	`+run:pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)`
	`42`	`+shell:Rscript {0}`
	`43`	`+`
	`44`	`+ -name:Deploy to GitHub pages 🚀`
	`45`	`+if:github.event_name != 'pull_request'`
	`46`	`+uses:JamesIves/github-pages-deploy-action@v4.5.0`
	`47`	`+with:`
	`48`	`+clean:false`
	`49`	`+branch:gh-pages`
	`50`	`+folder:docs`

Lines changed: 1 addition & 0 deletions

Lines changed: 2 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ Description: The log4r package is meant to provide a fast, lightweight,`
`14`	`14`	`object-oriented approach to logging in R based on the widely-emulated`
`15`	`15`	`'log4j' system and etymology.`
`16`	`16`	`License: Artistic-2.0`
`17`		`-URL: https://github.com/johnmyleswhite/log4r`
	`17`	`+URL: https://github.com/johnmyleswhite/log4r, https://log4r.r-lib.org`
`18`	`18`	`BugReports: https://github.com/johnmyleswhite/log4r/issues`
`19`	`19`	`Imports:`
`20`	`20`	`cli,`
`@@ -48,3 +48,4 @@ Collate:`
`48`	`48`	`'level.R'`
`49`	`49`	`'log4r-package.R'`
`50`	`50`	`'logger.R'`
	`51`	`+Config/Needs/website: tidyverse/tidytemplate`

Lines changed: 24 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,24 @@`
	`1`	`+url:https://log4r.r-lib.org`
	`2`	`+template:`
	`3`	`+package:tidytemplate`
	`4`	`+bootstrap:5`
	`5`	`+includes:`
	`6`	`+in_header:\|`
	`7`	`+ <script defer data-domain="log4r.r-lib.org,all.tidyverse.org" src="https://plausible.io/js/plausible.js"></script>`
	`8`	`+development:`
	`9`	`+mode:auto`
	`10`	`+reference:`
	`11`	`+-title:Basics`
	`12`	`+contents:`
	`13`	`+ -logger`
	`14`	`+ -log_at`
	`15`	`+-title:Appenders`
	`16`	`+contents:`
	`17`	`+ -appenders`
	`18`	`+ -syslog_appender`
	`19`	`+ -http_appender`
	`20`	`+ -tcp_appender`
	`21`	`+-title:Layouts`
	`22`	`+contents:layouts`
	`23`	`+-title:Advanced`
	`24`	`+contents:level`

Comments

(0)