From 9f2359886ac6abd1f17d37cabf0b902e73179e29 Mon Sep 17 00:00:00 2001 From: sorinvoicu <61691256+sorinvoicu@users.noreply.github.com> Date: Tue, 4 Jun 2024 08:54:37 +0000 Subject: [PATCH] update pkg docs and badge --- .github/workflows/pkgdown.yml | 8 ++++---- README.md | 1 + workflows.md | 5 ++++- 3 files changed, 9 insertions(+), 5 deletions(-) diff --git a/.github/workflows/pkgdown.yml b/.github/workflows/pkgdown.yml index d377b62..5ad72e4 100644 --- a/.github/workflows/pkgdown.yml +++ b/.github/workflows/pkgdown.yml @@ -33,8 +33,8 @@ jobs: uses: actions/checkout@v4 - name: Install package dependencies 📄 - uses: boehringer-ingelheim/dv.templates/.github/actions/dependencies@main - + uses: boehringer-ingelheim/dv.templates/.github/actions/dependencies@main + - name: Get validation results uses: actions/download-artifact@v4 with: @@ -47,8 +47,8 @@ jobs: - name: Check URLs 🌐 run: | - lychee . --format markdown --verbose --no-progress >> $GITHUB_STEP_SUMMARY - shell: bash + lychee . --format markdown --verbose --no-progress --exclude "https://boehringer-ingelheim.github.io*" >> $GITHUB_STEP_SUMMARY + shell: bash - name: Checkout gh-pages branch ⬇️ if: github.ref_name == 'main' diff --git a/README.md b/README.md index 8dd5ead..bfce9c8 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ [![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) [![Build status](https://github.com/boehringer-ingelheim/dv.templates/actions/workflows/styler.yml/badge.svg)](https://github.com/boehringer-ingelheim/dv.templates/actions/workflows/styler.yml?query=workflow) +[![Build status](https://github.com/boehringer-ingelheim/dv.templates/actions/workflows/release.yml/badge.svg)](https://github.com/boehringer-ingelheim/dv.templates/actions/workflows/release.yml?query=workflow) An R package template with built-in GitHub Actions-based CI/CD workflows. diff --git a/workflows.md b/workflows.md index e74009e..ac4d256 100644 --- a/workflows.md +++ b/workflows.md @@ -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. +### [`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. + ### [`shared_ci.yml`](https://github.com/boehringer-ingelheim/dv.templates/blob/main/.github/workflows/shared_ci.yml) Builds a reusable workflow to be called from other repositories. @@ -67,5 +71,4 @@ jobs: pkgdown: name: Pkgdown 📖 uses: boehringer-ingelheim/dv.templates/.github/workflows/pkgdown.yml@main - ```