https://github.com/quarto-dev/quarto-actions

https://github.com/quarto-dev/quarto-actions

Last synced: 9 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/quarto-dev/quarto-actions
• Owner: quarto-dev
• License: gpl-2.0
• Created: 2021-09-09T10:46:42.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-08-29T21:20:06.000Z (2 months ago)
• Last Synced: 2024-08-29T23:26:11.933Z (2 months ago)
• Language: PowerShell
• Size: 161 KB
• Stars: 216
• Watchers: 8
• Forks: 50
• Open Issues: 37
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-quarto - Quarto GitHub Actions - Official Quarto GitHub Actions allowing to setup, render, and deploy Quarto projects via GitHub Actions. (Continuous integration / Continuous deployment)
• jimsghstars - quarto-dev/quarto-actions - (PowerShell)

README

        
# Github Actions for Quarto

This repository stores [Github Actions](https://github.com/features/actions) useful for building and publishing [Quarto](https://quarto.org/) documents.

1. [quarto-dev/quarto-actions/setup](./setup) - Install Quarto

2. [quarto-dev/quarto-actions/render](./render) - Render project

3. [quarto-dev/quarto-actions/publish](./publish) - Publish project

We recommend using `v2` for your actions, and our examples all use `v2`.

## Examples

In [Examples](./examples), you will find a YAML workflow file to serve as a template to be reused as a base for your project. We are also sharing some links to real example Github repositories using Quarto with Github Actions for rendering and deploying documents and projects. If you want to add your repository in the list, we welcome a PR.

## Release Management

This repository uses [GitHub's recommended release management for actions](https://docs.github.com/en/actions/creating-actions/about-custom-actions#using-release-management-for-actions): 

* GitHub releases with tags are used for updates on the actions. 

* Semantic versioning is used, with major, minor and possibly patch release. 

* Major versions (such as `v1`) will always point to the last minor or patch release for this major version. (when `v1.0.2` is out, `v1` will point to this update, too). This means using `quarto-dev/quarto-actions/setup@v2` in your workflow file will automatically get the updated versions. Using `quarto-dev/quarto-actions/[email protected]` will pin a specific release.

* Major version changes (`v1` to `v2`) will often come with breaking changes, and workflows might require manual updates.