Skip to content

Commit

Permalink
update to BI org
Browse files Browse the repository at this point in the history
  • Loading branch information
sorinvoicu committed Feb 16, 2024
1 parent 88d6770 commit b27274f
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 19 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Title: What the Package Does
Version: 0.0.0.9100
Authors@R:
person("Sorin", "Voicu", , "[email protected]", role = c("aut", "cre"),
comment = c(ORCID = "sorinvoicu"))
comment = c(ORCID = "boehringer-ingelheim"))
Description: What the package does (one paragraph).
License: Apache License (>= 2)
Encoding: UTF-8
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

# dv.templates

[![Build status](https://github.com/sorinvoicu/dv.templates/actions/workflows/check.yml/badge.svg)](https://github.com/sorinvoicu/dv.templates/actions/workflows/check.yml?query=workflow)
[![Build status](https://github.com/sorinvoicu/dv.templates/actions/workflows/gitleaks.yml/badge.svg)](https://github.com/sorinvoicu/dv.templates/actions/workflows/gitleaks.yml?query=workflow)
[![Build status](https://github.com/sorinvoicu/dv.templates/actions/workflows/lintr.yml/badge.svg)](https://github.com/sorinvoicu/dv.templates/actions/workflows/lintr.yml?query=workflow)
[![Build status](https://github.com/sorinvoicu/dv.templates/actions/workflows/pkgdown.yml/badge.svg)](https://github.com/sorinvoicu/dv.templates/actions/workflows/pkgdown.yml?query=workflow)
[![Build status](https://github.com/sorinvoicu/dv.templates/actions/workflows/roxygen.yml/badge.svg)](https://github.com/sorinvoicu/dv.templates/actions/workflows/roxygen.yml?query=workflow)
[![Build status](https://github.com/boehringer-ingelheim/dv.templates/actions/workflows/check.yml/badge.svg)](https://github.com/boehringer-ingelheim/dv.templates/actions/workflows/check.yml?query=workflow)
[![Build status](https://github.com/boehringer-ingelheim/dv.templates/actions/workflows/gitleaks.yml/badge.svg)](https://github.com/boehringer-ingelheim/dv.templates/actions/workflows/gitleaks.yml?query=workflow)
[![Build status](https://github.com/boehringer-ingelheim/dv.templates/actions/workflows/lintr.yml/badge.svg)](https://github.com/boehringer-ingelheim/dv.templates/actions/workflows/lintr.yml?query=workflow)
[![Build status](https://github.com/boehringer-ingelheim/dv.templates/actions/workflows/pkgdown.yml/badge.svg)](https://github.com/boehringer-ingelheim/dv.templates/actions/workflows/pkgdown.yml?query=workflow)
[![Build status](https://github.com/boehringer-ingelheim/dv.templates/actions/workflows/roxygen.yml/badge.svg)](https://github.com/boehringer-ingelheim/dv.templates/actions/workflows/roxygen.yml?query=workflow)

An R package template with built-in GitHub Actions-based CI/CD workflows.

### Usage

All CI/CD jobs are defined in the [.github/workflows](https://github.com/sorinvoicu/dv.templates/blob/main/.github/workflows) directory in the form of GitHub Action workflows. These can be modified per your requirements, but are designed and implemented to follow best practices and to ensure the highest quality standards for your package.
All CI/CD jobs are defined in the [.github/workflows](https://github.com/boehringer-ingelheim/dv.templates/blob/main/.github/workflows) directory in the form of GitHub Action workflows. These can be modified per your requirements, but are designed and implemented to follow best practices and to ensure the highest quality standards for your package.

👉 For more information on workflows, please refer to the [Workflows documentation](./workflows.md).
4 changes: 2 additions & 2 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
url: https://sorinvoicu.github.io/dv.templates/
url: https://boehringer-ingelheim.github.io/dv.templates/

template:
bootstrap: 5

navbar:
right:
- icon: fa-github
href: https://github.com/sorinvoicu/dv.templates
href: https://github.com/boehringer-ingelheim/dv.templates
20 changes: 10 additions & 10 deletions workflows.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
# What these workflows do?

### [`check.yml`](https://github.com/sorinvoicu/dv.templates/blob/main/.github/workflows/check.yml)
### [`check.yml`](https://github.com/boehringer-ingelheim/dv.templates/blob/main/.github/workflows/check.yml)

Runs devtools::check() and devtools::test() on the R package inside the checked out repository.

### [`gitleaks.yml`](https://github.com/sorinvoicu/dv.templates/blob/main/.github/workflows/gitleaks.yml)
### [`gitleaks.yml`](https://github.com/boehringer-ingelheim/dv.templates/blob/main/.github/workflows/gitleaks.yml)

Runs [`gitleaks`](https://github.com/zricethezav/gitleaks) on the repo to discover any secrets that might have been hardcoded.

### [`lintr.yml`](https://github.com/sorinvoicu/dv.templates/blob/main/.github/workflows/lintr.yml)
### [`lintr.yml`](https://github.com/boehringer-ingelheim/dv.templates/blob/main/.github/workflows/lintr.yml)

Runs lintr on the repo with the linting settings specified in the container image.

### [`pkgdown.yml`](https://github.com/sorinvoicu/dv.templates/blob/main/.github/workflows/pkgdown.yml)
### [`pkgdown.yml`](https://github.com/boehringer-ingelheim/dv.templates/blob/main/.github/workflows/pkgdown.yml)

Generates a [`pkgdown`](https://pkgdown.r-lib.org/) website and uploads it to Github Pages.

### [`roxygen.yml`](https://github.com/sorinvoicu/dv.templates/blob/main/.github/workflows/roxygen.yml)
### [`roxygen.yml`](https://github.com/boehringer-ingelheim/dv.templates/blob/main/.github/workflows/roxygen.yml)

Uses [`roxygen`](https://roxygen2.r-lib.org/) to generate `.Rd` files in the
`man/` directory. It also checks if manuals are up-to-date with roxygen comments in the code.
Expand Down Expand Up @@ -44,23 +44,23 @@ on:
jobs:
check-test:
name: Check 📦
uses: sorinvoicu/dv.templates/.github/workflows/check.yml@main
uses: boehringer-ingelheim/dv.templates/.github/workflows/check.yml@main

lintr:
name: Lintr 🔍
uses: sorinvoicu/dv.templates/.github/workflows/lintr.yml@main
uses: boehringer-ingelheim/dv.templates/.github/workflows/lintr.yml@main
with:
lintr-error-on-lint: true

gitleaks:
name: Gitleaks 🌧️
uses: sorinvoicu/dv.templates/.github/workflows/gitleaks.yml@main
uses: boehringer-ingelheim/dv.templates/.github/workflows/gitleaks.yml@main

roxygen:
name: Roxygen 📄
uses: sorinvoicu/dv.templates/.github/workflows/roxygen.yml@main
uses: boehringer-ingelheim/dv.templates/.github/workflows/roxygen.yml@main

pkgdown:
name: Pkgdown 📖
uses: sorinvoicu/dv.templates/.github/workflows/pkgdown.yml@main
uses: boehringer-ingelheim/dv.templates/.github/workflows/pkgdown.yml@main
```

0 comments on commit b27274f

Please sign in to comment.