Attach built Quarto site to release assets and add maintainer docs#65
Attach built Quarto site to release assets and add maintainer docs#65
Conversation
|
Important Review skippedBot user detected. To trigger a single review, invoke the You can disable this status message by setting the
Comment |
|
@copilot add documentation in .github folder for maintainers |
Co-authored-by: maehr <14755525+maehr@users.noreply.github.com>
Co-authored-by: maehr <14755525+maehr@users.noreply.github.com>
Co-authored-by: maehr <14755525+maehr@users.noreply.github.com>
Co-authored-by: maehr <14755525+maehr@users.noreply.github.com>
Co-authored-by: maehr <14755525+maehr@users.noreply.github.com>
Co-authored-by: maehr <14755525+maehr@users.noreply.github.com>
…arify protected files
bf4b651 to
c843f0c
Compare
There was a problem hiding this comment.
Pull request overview
This PR adds a release-time workflow to rebuild and archive the Quarto site as a site.tar.gz asset on manual GitHub Releases, and updates documentation to guide maintainers and template users on archiving and workflow behavior.
Changes:
- Introduces
.github/workflows/release-site.ymlto render the Quarto site onrelease: published, JamPack-optimize it, archive_siteassite.tar.gz, and upload it to the corresponding GitHub Release. - Removes the generic built-site upload artifact from the Quarto publish workflow, keeping only the Pages deployment artifact.
- Updates README, TODO, AGENTS, and new
.github/MAINTAINERS.mdto explain the archiving model (CI artifacts vs Pages vs release assets vs Zenodo) and to expand template customization guidance.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| TODO.md | Adds CITATION.cff and DESCRIPTION to the placeholder-update checklist and a new checklist item describing the site.tar.gz release archive workflow. |
| README.template.md | Documents the new “Archiving and Artifacts” model, including the site.tar.gz release asset and Zenodo integration, for downstream projects. |
| README.md | Mirrors the “Archiving and Artifacts” explanation for the template repository’s own documentation. |
| AGENTS.md | Extends placeholder replacement and repository-structure guidance, adds a protected-files section, updates section numbering, and clarifies archiving via releases and Zenodo. |
| .github/workflows/release-site.yml | New workflow that builds, optimizes, tars, and uploads the Quarto _site directory as site.tar.gz to a published GitHub Release using gh release upload. |
| .github/workflows/quarto-publish.yml | Removes the now-redundant generic actions/upload-artifact step for _site, leaving only the Pages upload (actions/upload-pages-artifact). |
| .github/MAINTAINERS.md | New maintainer doc explaining routine maintenance, formatting/linting, and how manual releases trigger release-site.yml to attach site.tar.gz to releases. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - name: Render Quarto Project | ||
| uses: quarto-dev/quarto-actions/render@v2 | ||
| with: | ||
| to: html | ||
|
|
There was a problem hiding this comment.
For the template repository itself (maehr/open-research-data-template), this workflow renders using the templated _quarto.yml instead of the template-specific .github/_quarto.yml, so the archived site.tar.gz for releases won’t match the site that GitHub Pages deploys from quarto-publish.yml (which conditionally overwrites _quarto.yml). To keep the release archive consistent with the deployed documentation, consider adding a conditional “Overwrite _quarto.yml” step here mirroring the one in .github/workflows/quarto-publish.yml (guarded with if: github.repository == 'maehr/open-research-data-template') before the Quarto render step.
Pull request
Proposed changes
Manual releases should archive the rendered Quarto site as a release asset so Zenodo captures the deployed documentation without committing build artifacts. This update adds release-time packaging and upload of the built site, and includes maintainer documentation in
.githubfor release handling and upkeep.release.published, archive_site, and upload the archive to the existing release.site.tar.gzpayload for downstream archiving tools..github/MAINTAINERS.mdwith release asset guidance and routine maintenance steps.Types of changes
Checklist
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.