Skip to content

Check documentation-only PRs differently - #2401

Merged
simonkrogmann merged 1 commit into
remindmodel:developfrom
simonkrogmann:easy-doc-pr
Nov 16, 2026
Merged

simonkrogmann merged 1 commit into
remindmodel:developfrom
simonkrogmann:easy-doc-pr

Conversation

@simonkrogmann

@simonkrogmann simonkrogmann commented Jul 10, 2026 •

Copy link
Copy Markdown
Contributor

Purpose of this PR

To lower the hurdle of changing documentation and tutorials, boxes do not need to be ticked for tutorial PRs.

Points for discussion:

  • currently included: all .md files, all files in tutorials
  • I added the checkboxes to the impact list because I sometimes want to use them.
    ◻️ Deletion
    ◻️ Documentation / comments

Example of a passing docs only PR with the new form at my fork: simonkrogmann#5
I also tested that PRs with more edits still fail with unticked boxes.

Type of change

Indicate the items relevant for your PR by replacing ◻️ with ☑️.
Do not delete any lines. This makes it easier to understand which areas are affected by your changes and which are not.

Parts concerned

  • ◻️ GAMS Code
  • ◻️ R-scripts
  • ◻️ Documentation (GAMS incode documentation, comments, tutorials)
  • ◻️ Input data / CES parameters
  • ☑️ Tests, CI/CD (continuous integration/deployment)
  • ◻️ Configuration (switches in main.gms, default.cfg, and scenario_config*.csv files)
  • ◻️ Other (please give a description)

Impact

  • ◻️ Bug fix
  • ◻️ Refactoring
  • ☑️ New feature
  • ◻️ Change of parameter values or input data (including CES parameters)
  • ◻️ Minor change (default scenarios show only small differences)
  • ◻️ Fundamental change of results of default scenarios

Checklist

Do not delete any line. Leave unfinished elements unchecked so others know how far along you are.
In the end all checkboxes must be ticked before you can merge
.

  • I executed the automated model tests (make test) after my final commit and all tests pass (FAIL 0)
  • I adjusted the reporting in remind2 if and where it was needed
  • I adjusted the madrat packages (mrremind and other packages involved) for input data generation if and where it was needed
  • My code follows the coding etiquette
  • I explained my changes within the PR, particularly in hard-to-understand areas
  • I checked that the in-code documentation is up-to-date
  • I adjusted forbiddenColumnNames in readCheckScenarioConfig.R in case the PR leads to deprecated switches
  • I updated the CHANGELOG.md correctly (added, changed, fixed, removed, input data/calibration)

Further information (optional)

@simonkrogmann
simonkrogmann requested review from dklein-pik and tonnrueter and removed request for dklein-pik and tonnrueter July 11, 2026 10:16
@dklein-pik

Copy link
Copy Markdown
Contributor

Cool, thanks. Of course, GMS files also contain documentation (documentation embedded in the code in the form of comments). If we also want to allow changes in gms files for documentation only PRs, we would need to verify that the user has indeed edited only the comments in a GMS file.

@simonkrogmann

Copy link
Copy Markdown
Contributor Author

Do we have any reliable tool that can check if only comments were changed in a GMS file? I'd be favor for continuing to require make test if those files are changed.

@simonkrogmann

Copy link
Copy Markdown
Contributor Author

Also, my strategy doesn't seem to work on a github runner so I will look for another way of implementing this.

@dklein-pik

Copy link
Copy Markdown
Contributor

Do we have any reliable tool that can check if only comments were changed in a GMS file?

No, not that I know of.

@tobiasdiez

Copy link
Copy Markdown

Maybe helpful: https://github.com/marketplace/actions/changed-files#on-pull_request-

@simonkrogmann
simonkrogmann force-pushed the easy-doc-pr branch 5 times, most recently from ede65a2 to 17f54d6 Compare July 20, 2026 09:42
@simonkrogmann
simonkrogmann marked this pull request as draft August 24, 2026 16:23
@simonkrogmann
simonkrogmann force-pushed the easy-doc-pr branch 2 times, most recently from 152e0ca to 2eede84 Compare November 13, 2026 11:49
@simonkrogmann
simonkrogmann marked this pull request as ready for review November 13, 2026 14:56
@simonkrogmann
simonkrogmann merged commit 7cd726f into remindmodel:develop Nov 16, 2026
3 checks passed
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.

4 participants