Skip to content

Attach built Quarto site to release assets and add maintainer docs#65

Open
Copilot wants to merge 9 commits intomainfrom
copilot/fix-open-research-data-issue-33
Open

Attach built Quarto site to release assets and add maintainer docs#65
Copilot wants to merge 9 commits intomainfrom
copilot/fix-open-research-data-issue-33

Conversation

Copy link
Contributor

Copilot AI commented Jan 17, 2026

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 .github for release handling and upkeep.

  • Release publish workflow: rebuild/optimize the Quarto site on release.published, archive _site, and upload the archive to the existing release.
  • Asset packaging: provide a single site.tar.gz payload for downstream archiving tools.
  • Maintainer docs: add .github/MAINTAINERS.md with release asset guidance and routine maintenance steps.
- name: Compress built site
  run: tar -czf site.tar.gz -C _site .
- name: Upload site to release
  run: gh release upload ${{ github.event.release.tag_name }} site.tar.gz --clobber

Types of changes

  • New feature (non-breaking change which adds functionality).
  • Enhancement (non-breaking change which enhances functionality)
  • Bug Fix (non-breaking change which fixes an issue).
  • Breaking change (fix or feature that would cause existing functionality to change).

Checklist

  • I have read the README document.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
Original prompt

Implement #33


💡 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.

@coderabbitai
Copy link

coderabbitai bot commented Jan 17, 2026

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

  • 🔍 Trigger a full review

Comment @coderabbitai help to get the list of available commands and usage tips.

Copilot AI changed the title [WIP] Fix issue 33 in open research data template Attach built Quarto site to release assets Jan 17, 2026
Copilot AI requested a review from maehr January 17, 2026 15:20
@maehr
Copy link
Owner

maehr commented Jan 17, 2026

@copilot add documentation in .github folder for maintainers

Copy link
Contributor Author

Copilot AI commented Jan 17, 2026

@copilot add documentation in .github folder for maintainers

Added .github/MAINTAINERS.md with maintainer guidance and release asset notes in 55e7409.

Copilot AI changed the title Attach built Quarto site to release assets Attach built Quarto site to release assets and add maintainer docs Jan 17, 2026
@maehr maehr marked this pull request as ready for review February 3, 2026 13:22
Copilot AI review requested due to automatic review settings February 3, 2026 13:22
Copilot AI and others added 9 commits February 3, 2026 14:22
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>
@maehr maehr force-pushed the copilot/fix-open-research-data-issue-33 branch from bf4b651 to c843f0c Compare February 3, 2026 13:23
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.yml to render the Quarto site on release: published, JamPack-optimize it, archive _site as site.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.md to 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.

Comment on lines +35 to +39
- name: Render Quarto Project
uses: quarto-dev/quarto-actions/render@v2
with:
to: html

Copy link

Copilot AI Feb 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants