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.

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

Run pkgdown for published releases and on workflow_dispatch #451

Merged
merged 4 commits into from
Dec 8, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions examples/README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,7 @@ print_yaml("render-rmarkdown.yaml")

This example builds a [pkgdown] site for a repository and pushes the built package
to [GitHub Pages].
The inclusion of [`workflow_dispatch`](https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows#workflow_dispatch) means the workflow can be [run manually, from the browser](https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow), or [triggered via the GitHub REST API](https://docs.github.com/en/rest/reference/actions/#create-a-workflow-dispatch-event).

```{r echo = FALSE, results = "asis"}
print_yaml("pkgdown.yaml")
Expand Down
14 changes: 11 additions & 3 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -462,7 +462,8 @@ jobs:
`usethis::use_github_action("render-rmarkdown")`

This example automatically re-builds any Rmarkdown file in the
repository whenever it changes and commits the results.
repository whenever it changes and commits the results to the master
branch.

``` yaml
# Workflow derived from https://github.com/r-lib/actions/tree/master/examples
Expand Down Expand Up @@ -509,15 +510,22 @@ jobs:

This example builds a [pkgdown](https://pkgdown.r-lib.org/) site for a
repository and pushes the built package to [GitHub
Pages](https://pages.github.com/).
Pages](https://pages.github.com/). The inclusion of
[`workflow_dispatch`](https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows#workflow_dispatch)
means the workflow can be [run manually, from the
browser](https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow),
or [triggered via the GitHub REST
API](https://docs.github.com/en/rest/reference/actions/#create-a-workflow-dispatch-event).

``` yaml
# Workflow derived from https://github.com/r-lib/actions/tree/master/examples
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
on:
push:
branches: [main, master]
tags: ['*']
release:
types: [published]
workflow_dispatch:

name: pkgdown

Expand Down
4 changes: 3 additions & 1 deletion examples/pkgdown-pak.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@
on:
push:
branches: [main, master]
tags: ['*']
release:
types: [published]
workflow_dispatch:

name: pkgdown

Expand Down
4 changes: 3 additions & 1 deletion examples/pkgdown.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@
on:
push:
branches: [main, master]
tags: ['*']
release:
types: [published]
workflow_dispatch:

name: pkgdown

Expand Down