Skip to content

Commit ee77c86

Browse files
committed
document draft-check workflow and detect-drafts action in README
1 parent 8d3b5f9 commit ee77c86

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

.github/workflows/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,24 @@ Note that technically, <prerelease.quarto.org> is also a deploy preview on Netli
3535
- This index file is retrieved on deployed website to be updated on Algolia.
3636
- Both `quarto.org` and `prerelease.quarto.org` indexes are updated in the same run - they each use one specific algolia index
3737

38+
- `draft-check.yml` - A lightweight workflow that detects `draft: true` pages among changed `.qmd` files. Runs on all PRs to `main` and `prerelease` with no `paths-ignore`, so it always creates a status check.
39+
- Uses the reusable composite action at `.github/workflows/actions/detect-drafts/`.
40+
- Configured as a required status check on `main` (`check-drafts` job), blocking merge until `draft: true` is removed.
41+
- Admin override is available for intentional draft merges.
42+
3843
- `port-to-prerelease.yml` - This workflow is used to sync changes made to main for quarto.org to prerelease branch for prerelease.quarto.org.
3944
- It is triggered when a PR is merged in to `main`. It can also be triggered manually by adding a comment `/sync-prerelease` on a merged PR.
4045
- This workflow uses [`korthout/backport-action`](https://github.com/korthout/backport-action) to create a PR with the changes merged into `main` branch to be synced to `prerelease` branch.
4146
- It will also write a new `/deploy-preview` comment in the new PR to trigger the preview deployment from `preview.yml`.
4247
- This is possible because it uses a fine-grained PAT token which allows a workflow to trigger another using usual event (GITHUB_TOKEN does not allow that usually). This is configured in repo secrets.
4348

49+
## Reusable Composite Actions
50+
51+
Local composite actions live in `.github/workflows/actions/`:
52+
53+
- `detect-drafts/` - Scans changed `.qmd` files for `draft: true` in YAML frontmatter. Outputs `found` (true/false) and `files` (newline-separated paths). Used by both `preview.yml` (to tag drafts in the PR comment) and `draft-check.yml` (to fail the required check).
54+
- `release-info/` - Retrieves release information from the quarto-cli repository.
55+
4456
## Netlify Configurations
4557

4658
- This repo has a `_redirects` file in the root directory. Otherwise, configuration are made in NETLIFY UI. Quarto website is inside Posit Netlify account.

0 commit comments

Comments
 (0)