Skip to content

Commit

Permalink
Remove roxygen action. Adapt docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
ml-ebs-ext committed Jan 27, 2025
1 parent 27cb571 commit 7c4402d
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 63 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ jobs:
# we check the target branch inside the script (as opposed to in GH actions) to facilitate future merging of actions
if [ "$TARGET_BRANCH" = "main" ] && [ $VERSION_COMPONENT_COUNT -ge 4 ]; then
echo "❌ Version on DESCRIPTION has more than three components (X.X.X) and is targetting the 'main' branch."
echo "❌ Version on DESCRIPTION has more than three components (X.X.X) and is targeting the 'main' branch."
RESULT=1
fi
Expand Down
46 changes: 0 additions & 46 deletions .github/workflows/roxygen.yml

This file was deleted.

4 changes: 0 additions & 4 deletions .github/workflows/shared_ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,6 @@ jobs:
with:
lintr_error_on_lint: true

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

pkgdown:
name: Pkgdown 📖
uses: boehringer-ingelheim/dv.templates/.github/workflows/pkgdown.yml@main
Expand Down
17 changes: 5 additions & 12 deletions workflows.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# What these workflows do?
# What do these workflows do?

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

Expand All @@ -14,16 +14,13 @@ Runs lintr on the repo with the linting settings specified in the container imag

### [`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/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. (Currently broken).
Generates `man/*.Rd` documentation through [`roxygen`](https://roxygen2.r-lib.org/).
Renders a [`pkgdown`](https://pkgdown.r-lib.org/) website and uploads it to Github Pages.

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

Uses adds additional checks before merging the PR to main.
Checks that version numbers in `NEWS.md` and `DESCRIPTION` match.
Checks that version numbers don't have a fourth component (major.minor.patch.**dev**) on PRs targeting `main`.

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

Expand Down Expand Up @@ -60,10 +57,6 @@ jobs:
with:
lintr_error_on_lint: true

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

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

0 comments on commit 7c4402d

Please sign in to comment.