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

Only build & deploy pkgdown on release #529

Merged
merged 1 commit into from
Jan 9, 2024
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
10 changes: 10 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,16 @@ with write access to code and workflows.
It should be saved as the `APP_PUSH_TEST_PAT`
[repository secret](https://github.com/Appsilon/rhino/settings/secrets/actions).

## Website

The [documentation site](https://appsilon.github.io/rhino/)
is built and deployed automatically by our [`pkgdown.yml`](workflows/pkgdown.yml) workflow.
This workflow is triggered when a
[release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository)
is published, or a pre-release is changed to a release.
It is also possible to manually run it for a selected tag/branch
from the [Actions](https://github.com/Appsilon/rhino/actions/workflows/pkgdown.yml) tab.

## Release process

### Preparation
Expand Down
9 changes: 7 additions & 2 deletions .github/workflows/pkgdown.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
name: pkgdown
on:
push:
branches: [main]
# Run when a release is published, or a pre-release is changed to a release. Reference:
# https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#release
# https://docs.github.com/en/webhooks/webhook-events-and-payloads#release
release:
types: [released]
# It is also possible to manually trigger this workflow for a selected tag/branch
# from the "Actions" tab on GitHub.
workflow_dispatch:
permissions:
contents: write
Expand Down
Loading