Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: fix pkgdown #263

Merged
merged 9 commits into from
Mar 1, 2024
Merged

ci: fix pkgdown #263

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
3440c7f
pkgdown: wrote custom build_site_github_pages
dsweber2 Mar 1, 2024
bdc2031
parentheses, accidental line
dsweber2 Mar 1, 2024
5ed99a9
overide!=override
dsweber2 Mar 1, 2024
e5b7918
style: styler (GHA)
dsweber2 Mar 1, 2024
3d44b2d
speeling and not overwriting existing function
dsweber2 Mar 1, 2024
e51e2a2
build_github_pages is internal to pkgdown, so import
dsweber2 Mar 1, 2024
282eace
ci: use a single epidatr key env var
dshemetov Mar 1, 2024
d6df787
ci: add cli dependency
dshemetov Mar 1, 2024
e63a926
style: styler
dshemetov Mar 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions .github/workflows/pkgdown.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:
group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
DELPHI_EPIDATA_KEY: ${{ secrets.DELPHI_GITHUB_ACTIONS_EPIDATA_API_KEY }}
DELPHI_EPIDATA_KEY: ${{ secrets.SECRET_EPIDATR_GHACTIONS_DELPHI_EPIDATA_KEY }}
steps:
- uses: actions/checkout@v3

Expand All @@ -35,19 +35,21 @@ jobs:

- uses: r-lib/actions/setup-r-dependencies@v2
with:
extra-packages: any::pkgdown, local::.
extra-packages: any::pkgdown, local::., any::cli
needs: website

- name: Build site
env:
DELPHI_EPIDATA_KEY: ${{ secrets.SECRET_EPIDATR_GHACTIONS_DELPHI_EPIDATA_KEY }}
run: |
if (startsWith("${{ github.event_name }}", "pull_request")) {
mode <- ifelse("${{ github.base_ref }}" == "main", "release", "devel")
mode_ref <- ifelse("${{ github.base_ref }}" == "main", "release", "devel")
} else {
mode <- ifelse("${{ github.ref_name }}" == "main", "release", "devel")
mode_ref <- ifelse("${{ github.ref_name }}" == "main", "release", "devel")
}
pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE, override=list(PKGDOWN_DEV_MODE=mode))
pkg <- pkgdown::as_pkgdown(".", override = list(destination = ifelse(mode_ref == "release", "docs", "docs/dev"), PKGDOWN_DEV_MODE = mode_ref))
cli::cli_rule("Cleaning files from old site...")
pkgdown::clean_site(pkg)
pkgdown::build_site(pkg, preview = FALSE, install = FALSE, new_process = FALSE)
pkgdown:::build_github_pages(pkg)
shell: Rscript {0}

- name: Deploy to GitHub pages 🚀
Expand Down
7 changes: 6 additions & 1 deletion R/utils.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,5 +70,10 @@ get_wildcard_equivalent_dates <- function(time_value, time_type = c("day", "week
#' inserts each string as a bullet at the end of the "Prepare for release" section
#' @keywords internal
release_bullets <- function() {
c("merge to main")
c(
"merge to main",
"don't use_version('patch') in the next section",
"`use_version('patch')` is redundant because we do this in PRs",
"`use_dev_version` is also redundant."
)
}
2 changes: 2 additions & 0 deletions _pkgdown.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Colors should stay consistent across epipredict & epidatr, using Carnegie
# Red https://www.cmu.edu/brand/brand-guidelines/visual-identity/colors.html
development:
mode: devel
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need this, if we're overwriting whenever we build pages?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was mostly just trying to be explicit about the default

template:
bootstrap: 5
bootswatch: cosmo
Expand Down
Loading