Merge pull request #451 from r-lib/update-event-triggers-for-pkgdown

Author: gaborcsardi

examples/README.Rmd

@@ -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")

examples/README.md

@@ -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
@@ -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
 

examples/pkgdown-pak.yaml

@@ -3,7 +3,9 @@
 on:
   push:
     branches: [main, master]
-    tags: ['*']
+  release:
+    types: [published]
+  workflow_dispatch:
 
 name: pkgdown
 

examples/pkgdown.yaml

@@ -3,7 +3,9 @@
 on:
   push:
     branches: [main, master]
-    tags: ['*']
+  release:
+    types: [published]
+  workflow_dispatch:
 
 name: pkgdown