From f23016b8212c17fa1ef735382a5adbcbd7b2ad0c Mon Sep 17 00:00:00 2001 From: Indrajeet Patil Date: Fri, 13 Dec 2024 16:39:17 +0530 Subject: [PATCH] Add GHA (#3) * Add GHA * add description * Update DESCRIPTION --- .github/.gitignore | 1 + .github/CODE_OF_CONDUCT.md | 126 ++++++++++++++++++++++++++++++++ .github/dependabot.yaml | 8 ++ .github/workflows/bookdown.yaml | 58 +++++++++++++++ .gitignore | 5 ++ DESCRIPTION | 28 +++++++ _output.yml | 2 - 7 files changed, 226 insertions(+), 2 deletions(-) create mode 100644 .github/.gitignore create mode 100644 .github/CODE_OF_CONDUCT.md create mode 100644 .github/dependabot.yaml create mode 100644 .github/workflows/bookdown.yaml create mode 100644 DESCRIPTION diff --git a/.github/.gitignore b/.github/.gitignore new file mode 100644 index 0000000..2d19fc7 --- /dev/null +++ b/.github/.gitignore @@ -0,0 +1 @@ +*.html diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..ebbc507 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,126 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at patilindrajeet.science@gmail.com. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][https://github.com/mozilla/inclusion]. + +For answers to common questions about this code of conduct, see the FAQ at +. Translations are available at . + +[homepage]: https://www.contributor-covenant.org diff --git a/.github/dependabot.yaml b/.github/dependabot.yaml new file mode 100644 index 0000000..70b670e --- /dev/null +++ b/.github/dependabot.yaml @@ -0,0 +1,8 @@ +version: 2 + +updates: + # Keep dependencies for GitHub Actions up-to-date + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "weekly" diff --git a/.github/workflows/bookdown.yaml b/.github/workflows/bookdown.yaml new file mode 100644 index 0000000..1e0e6f7 --- /dev/null +++ b/.github/workflows/bookdown.yaml @@ -0,0 +1,58 @@ +# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples +# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help +on: + push: + branches: [main, master] + pull_request: + branches: [main, master] + schedule: + # * is a special character in YAML so you have to quote this string + # Trigger once a week, on a Sunday (0) + - cron: "0 0 * * 0" + workflow_dispatch: + +name: bookdown + +jobs: + bookdown: + runs-on: ubuntu-latest + + env: + GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} + + steps: + - uses: actions/checkout@v4 + + - uses: r-lib/actions/setup-pandoc@v2 + with: + pandoc-version: "latest" + + - uses: r-lib/actions/setup-tinytex@v2 + - run: | + tlmgr --version + + - uses: r-lib/actions/setup-r@v2 + with: + use-public-rspm: true + + - uses: r-lib/actions/setup-r-dependencies@v2 + + - name: Cache bookdown results + uses: actions/cache@v4 + with: + path: _bookdown_files + key: bookdown-${{ hashFiles('**/*Rmd') }} + restore-keys: bookdown- + + - name: Build site + run: | + library(bookdown) + render_book("index.Rmd", output_format = "all", quiet = FALSE) + shell: Rscript {0} + + - name: Deploy to GitHub pages 🚀 + if: github.event_name != 'pull_request' + uses: JamesIves/github-pages-deploy-action@v4.7.2 + with: + branch: gh-pages + folder: _book diff --git a/.gitignore b/.gitignore index 476486f..9cf1be2 100644 --- a/.gitignore +++ b/.gitignore @@ -39,3 +39,8 @@ vignettes/*.pdf .Renviron rsconnect +.github/.DS_Store +_bookdown_files +.DS_Store +_book +_main.* diff --git a/DESCRIPTION b/DESCRIPTION new file mode 100644 index 0000000..87a9d36 --- /dev/null +++ b/DESCRIPTION @@ -0,0 +1,28 @@ +Type: Book +Package: R-Function-A-Day +Title: Tweets from 'R Function A Day' account +Version: 0.1.0 +Authors@R: + person("Indrajeet", "Patil", , "patilindrajeet.science@gmail.com", role = c("cre", "aut"), + comment = c(ORCID = "0000-0003-1995-6531")) +Description: This book contains tweets from 'R Function A Day' account. + This is not a package, and the DESCRIPTION file is included to make it + easier to install required packages in GitHub action workflows. +License: CC0 1.0 Universal +URL: https://github.com/IndrajeetPatil/R-Function-A-Day, + https://indrajeetpatil.github.io/R-Function-A-Day/ +BugReports: https://github.com/IndrajeetPatil/R-Function-A-Day/issues +Depends: + R (>= 4.1.0) +Imports: + bookdown, + downlit, + jsonlite, + knitr, + sessioninfo, + tidyverse, + xml2 +Encoding: UTF-8 +LazyData: false +Roxygen: list(markdown = TRUE) +RoxygenNote: 7.3.2 diff --git a/_output.yml b/_output.yml index f376ec6..d3e0a97 100644 --- a/_output.yml +++ b/_output.yml @@ -7,6 +7,4 @@ bookdown::pdf_book: includes: in_header: preamble.tex latex_engine: xelatex - #citation_package: natbib # nothing to cite - keep_tex: yes bookdown::epub_book: default