Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
13 changes: 0 additions & 13 deletions .github/workflows/greetings.yml

This file was deleted.

55 changes: 55 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
on:
release:
types: [published]

name: Attach Rendered Site to Release

permissions:
contents: write

jobs:
build-and-attach:
name: Build Site and Upload Release Asset
runs-on: ubuntu-latest

steps:
- name: Check out repository
uses: actions/checkout@v5

- name: Overwrite _quarto.yml
if: github.repository == 'maehr/open-research-data-template'
run: |
cp .github/_quarto.yml _quarto.yml

- name: Set up Quarto
uses: quarto-dev/quarto-actions/setup@v2
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Install uv
uses: astral-sh/setup-uv@v6

- name: Setup R
uses: r-lib/actions/setup-r@v2
with:
r-version: renv
- uses: r-lib/actions/setup-renv@v2

- name: Render Quarto Project
uses: quarto-dev/quarto-actions/render@v2
with:
to: html

- name: JamPack Optimization
run: |
npx @divriots/jampack ./_site

- name: Package site into ZIP
run: |
cd _site
zip -r ../site-${{ github.event.release.tag_name }}.zip .

- name: Upload release asset
uses: softprops/action-gh-release@v2
with:
files: site-${{ github.event.release.tag_name }}.zip
1 change: 1 addition & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ Place new files accordingly.
## 10) Zenodo Integration and DOI (Project instances)

- **Enable Zenodo–GitHub integration** to archive releases and mint DOIs.
- The `release.yml` workflow automatically builds the rendered site and attaches it as a `site-<tag>.zip` release asset so that Zenodo archives the HTML documentation alongside the source code.
- After first release:
- Record your **`ZENODO_RECORD`** and **`DOI`**.
- **Zenodo DOI badge**: replace `GITHUB_REPO_ID` with the numeric repo ID from `https://api.github.com/repos/USERNAME/REPO_NAME` (`id` field). Badge will display your DOI after Zenodo links the release.
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Conventional data publication as static supplementary files offers limited repro
### Open Research Data

- Citable via [DOI](https://www.doi.org/) and [CITATION.cff](https://citation-file-format.github.io/)
- Automatic long-term archiving with [Zenodo](https://zenodo.org/)
- Automatic long-term archiving with [Zenodo](https://zenodo.org/), including the rendered documentation site as a release asset
- Licensed under [AGPL 3.0](https://www.gnu.org/licenses/agpl-3.0.html) and [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/deed) according to [The Turing Way](https://the-turing-way.netlify.app/reproducible-research/rdm/rdm-sharing.html#step-3-choose-a-licence-and-link-to-your-paper-and-code)
- Template for reporting data issues via `github/ISSUE_TEMPLATE/data_issue_report.yml`

Expand Down Expand Up @@ -67,7 +67,7 @@ Conventional data publication as static supplementary files offers limited repro
### Ethics

- `CODE_OF_CONDUCT.md` following the [Contributor Covenant](https://www.contributor-covenant.org/)
- Supportive first interactions via [Greetings](https://github.com/actions/starter-workflows/blob/main/automation/greetings.yml)


## Selected Use Cases

Expand Down
2 changes: 2 additions & 0 deletions TODO.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ Complete the following steps after creating your project from this template to c

- [ ] **Review Project-Management Files**: Populate or remove the files in `project-management/` before publishing. These are placeholder templates for meeting notes and project plans.

- [ ] **Rendered Site in Releases**: The `release.yml` workflow automatically builds the Quarto site and attaches a `site-<tag>.zip` to each GitHub release. This ensures the rendered HTML documentation is preserved alongside the source archive when Zenodo captures the release.

## Verification Steps

After completing the checklist:
Expand Down
Loading