Skip to content

Commit

Permalink
update workflow documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sorinvoicu committed Feb 29, 2024
1 parent cff0b9a commit 4727a84
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ Generates a [`pkgdown`](https://pkgdown.r-lib.org/) website and uploads it to Gi
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.

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

Checks for broken links inside the repo.

Example configuration for `main` branch:

```yaml
Expand Down Expand Up @@ -63,4 +67,8 @@ jobs:
pkgdown:
name: Pkgdown 📖
uses: boehringer-ingelheim/dv.templates/.github/workflows/pkgdown.yml@main

links:
name: Check URLs 🌐
uses: boehringer-ingelheim/dv.templates/.github/workflows/links.yml@main
```

0 comments on commit 4727a84

Please sign in to comment.