Skip to content

Add the caller and the commands that adopt an EnergyPlus release - #36

Open
samuelduchesne wants to merge 2 commits into
mainfrom
adopt-energyplus
Open

samuelduchesne wants to merge 2 commits into
mainfrom
adopt-energyplus

Conversation

@samuelduchesne

Copy link
Copy Markdown
Contributor

1. Change

  1. .github/workflows/adopt-energyplus.yml: the caller of the reusable adoption workflow. The caller holds no logic: the steps, their order and the gate are declared for this project in governance/energyplus.toml of idfkit-conformance at governance-2026.24. The run never merges, publishes, releases or deploys.
  2. scripts/adopt_release.py:
    • target-list vX.Y.Z adds the release to TARGET_VERSIONS in scripts/config.py and sets LATEST_VERSION. It refuses unless the installed idfkit lists the release.
    • doc-sets vX.Y.Z reports, without writing anything, the upstream documentation directories that no configured set matches and the sets whose source format changed since the preceding release.

2. Verification

  1. make check passes; the script passes ruff check and ruff format --check.
  2. target-list v26.2.0 exits 1 with the stated reason, since no published idfkit lists 26.2.0. Its success path was run only with the registry patched in process.
  3. doc-sets v26.2.0 against upstream: 13 of 13 configured sets found, none changed format; acknowledgments and quick_start remain unmatched, as in v26.1.0.
  4. Not verified: the caller on GitHub.

The steps, their order and the gate are declared for this project in
governance/energyplus.toml of idfkit-conformance, read at
governance-2026.24. The commands those steps name are added here.
github-actions Bot added a commit that referenced this pull request Oct 14, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Docs preview for this PR is available at:
https://docs.idfkit.com/pr-preview/pr-36/

…-sets report

1. target-list refuses when another patch release of the same MAJOR.MINOR is listed. Build and published paths are named vMAJOR.MINOR, so two such entries would overwrite each other.
2. The doc-sets report compares the LaTeX and Sphinx trees separately, so an unmatched directory that moves between trees under one name is reported, and states when no preceding release was surveyed.
3. Each git command of the upstream fetch has a time limit and is named in its failure message.
4. Comments and the module docstring state that the report reaches the pull request body and the job summary, and that the newest listed release is designated LATEST_VERSION.

This branch has not been deployed

No deployments
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.

1 participant