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

README info for actions files #15

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

README info for actions files #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,15 @@
# ocdo

## Quarto check

A GitHub Action (`.github/workflows/quarto-check.yml`) runs on every push to `main` and every pull request opened against `main`. This GH Action runs `quarto render` to make sure quarto can render the site in a "clean environment". This GH Action does not deploy the site.

Maintainence: may require updating action versions as desired or upon errors

## Pull request previews

A GitHub Action (`.github/workflows/deploy-preview.yml`) runs on every pull request opened against `main` to render the site for the code in the PR in [Netlify](https://www.netlify.com/). Netlify is a platform for deploying and hosting websites, and will render previews of pull requests for public GitHub repositories.

If the build succeeds there will be a bot comment with a link to the preview. There's a single link per pull request. On subsequent commits added to the same PR, the link stays the same.

Maintainence: may require updating action versions as desired or upon errors. In addition, the yml file is configureable; changes can be made as desired (e.g., you can change the message that's sent by the bot). The Netlify auth token may need to be updated in the future under repository Settings > Secrets and variables > Actions > Repository secrets.
Loading