Sync study summary to v0.2.0; per-file protocol version check#9
Open
DougManuel wants to merge 2 commits into
Open
Sync study summary to v0.2.0; per-file protocol version check#9DougManuel wants to merge 2 commits into
DougManuel wants to merge 2 commits into
Conversation
study-summary.qmd had drifted to v0.1.0 (2025-03-27, the original outline) while the full protocol advanced to v0.3.2. Bump the summary to v0.2.0 on its own independent track, noting it corresponds to full protocol v0.3.2. Content was broadly accurate; the only stale items fixed are the harmonization appendix reference (Appendix A) and terminology (CSHM, OncoSim). No change to study scope or methods. Redesign .github/workflows/protocol-version.yml to enforce versioning per document: study-summary.qmd bumps its own plain-text Version stamp; full-protocol.qmd (and appendices, which have no own stamp) bump version-summary.version. The previous check read only full-protocol's version, so a PR touching only the summary would have failed. Update the CLAUDE.md protocol-versioning section to document the two independent tracks.
There was a problem hiding this comment.
Pull request overview
This PR synchronizes the one-page study summary document’s versioning with the current protocol state and updates CI enforcement so protocol version bumps are checked per-document (independent version tracks for study-summary.qmd vs. full-protocol.qmd/appendices).
Changes:
- Bumps
docs/protocol/study-summary.qmdto v0.2.0, updates date, adds correspondence note to full protocol v0.3.2, and adds a changelog entry. - Revises
.github/workflows/protocol-version.ymlto enforce version bumps per changed protocol document (summary vs. full protocol track). - Documents the independent versioning tracks in
CLAUDE.md.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/protocol/study-summary.qmd | Updates summary version/date and aligns references/terminology; adds correspondence note + change log entry |
| CLAUDE.md | Documents the independent protocol versioning tracks and CI enforcement |
| .github/workflows/protocol-version.yml | Updates CI to require version bumps on the correct track depending on which protocol document changed |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## Expected Outcomes | ||
|
|
||
| The primary outcome will be a Canadian Smoking Histories Model capable of producing detailed smoking histories by birth cohort, age, sex, and region. The model will provide annual estimates of smoking prevalence, initiation rates, cessation rates, and smoking intensity, both historically (1965-2023) and projected forward (2024-2050). This model will be made available through an online interactive platform and open-source code repository, enabling researchers and policymakers to access detailed smoking parameters for health economic modelling, policy evaluation, and public health planning. The Generator will support various policy planning models, such as Oncosim and POHEM, designed to evaluate the impact of tobacco control policies and predict smoking-attributable disease burden, including cancer, cardiovascular disease, and dementia. By providing Canada-specific smoking parameters at both national and provincial levels, this Generator will enable a more precise estimation of the health and economic impacts in the Canadian context and support evidence-based tobacco control strategies. | ||
| The primary outcome will be a Canadian Smoking Histories Model capable of producing detailed smoking histories by birth cohort, age, sex, and region. The model will provide annual estimates of smoking prevalence, initiation rates, cessation rates, and smoking intensity, both historically (1965-2023) and projected forward (2024-2050). This model will be made available through an online interactive platform and open-source code repository, enabling researchers and policymakers to access detailed smoking parameters for health economic modelling, policy evaluation, and public health planning. The CSHM will support various policy planning models, such as OncoSim and POHEM, designed to evaluate the impact of tobacco control policies and predict smoking-attributable disease burden, including cancer, cardiovascular disease, and dementia. By providing Canada-specific smoking parameters at both national and provincial levels, this Generator will enable a more precise estimation of the health and economic impacts in the Canadian context and support evidence-based tobacco control strategies. |
Comment on lines
+43
to
+52
| # full-protocol.qmd: version-summary.version frontmatter | ||
| full_version() { | ||
| git show "$1:docs/protocol/full-protocol.qmd" 2>/dev/null \ | ||
| | awk '/^version-summary:/{f=1; next} f && /version:/{gsub(/[" ]/, "", $2); print $2; exit}' | ||
| } | ||
| base_version=$(get_version "$base") | ||
| head_version=$(get_version HEAD) | ||
| echo "Base version: ${base_version:-<none>} | Head version: ${head_version:-<none>}" | ||
| # study-summary.qmd: first plain-text "Version X.Y.Z" stamp | ||
| summary_version() { | ||
| git show "$1:docs/protocol/study-summary.qmd" 2>/dev/null \ | ||
| | grep -m1 -oE 'Version [0-9]+\.[0-9]+\.[0-9]+' | awk '{print $2}' | ||
| } |
- study-summary.qmd: fix the leftover 'this Generator' in the Expected Outcomes paragraph (-> 'the model'); the earlier sentence was aligned to CSHM but this one was missed. Completes the terminology cleanup the 0.2.0 change-log entry describes. - protocol-version.yml: make the version getters return empty (not a non-zero exit) when a file is absent from a ref, so set -e no longer aborts the step on a newly added / deleted / renamed protocol file and the explicit empty-string error handling runs as intended. Verified with a set -euo pipefail harness.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Brings the one-page study summary's version into sync and makes the protocol-version CI check enforce independent version tracks per document.
The problem
study-summary.qmdhad drifted to v0.1.0 (2025-03-27 — the original outline) whilefull-protocol.qmdadvanced to v0.3.2. Its content was broadly accurate (APC initiation/cessation, MPoRT, 1965–2023 historical + projections to 2050, provincial, open-source all matched), so this is a versioning-sync, not a content rewrite.Changes
study-summary.qmd→ v0.2.0 on its own track, with a line noting it corresponds to full protocol v0.3.2 and a## Change logentry. Stale-content fixes: harmonization appendix reference (Appendix X→Appendix A) and terminology (Generator/Oncosim→CSHM/OncoSim). No scope or methods change.protocol-version.ymlredesigned to be per-file: the summary bumps its own plain-textVersion X.Y.Z;full-protocol.qmd(and appendices, which carry no own stamp) bumpversion-summary.version. The previous check read onlyfull-protocol.qmd's version, so a PR touching only the summary — like this one — would have failed it.Validation
Version parsing verified locally against base vs. head: summary
0.1.0 → 0.2.0(differs → passes); full-protocol0.3.2unchanged and not in this PR's protocol diff, so its branch of the check does not fire. This PR exercises the new summary-track branch of the check.