Skip to content

Add the EnergyPlus adoption caller, and the command that lists an adopted release - #27

Merged
samuelduchesne merged 1 commit into
mainfrom
adopt-energyplus
Oct 14, 2026
Merged

samuelduchesne merged 1 commit into
mainfrom
adopt-energyplus

Conversation

@samuelduchesne

Copy link
Copy Markdown
Contributor

1. Purpose

This pull request adds the EnergyPlus adoption caller for this project, together with the command that the roster's release-rows step runs. It is part of spec 012 (specs/012-energyplus-release-adoption in idfkit-unification). The steps and the gate are declared for idfkit-developers in governance/energyplus.toml of idfkit-conformance at governance-2026.25.

2. Changes

  1. .github/workflows/adopt-energyplus.yml: calls the reusable adopt-energyplus.yml of idfkit-conformance at governance-2026.25, and states the tag a second time as governance_level. It holds no logic. It grants contents: write and pull-requests: write only. It never merges, publishes or releases.

  2. scripts/adopt_release.py: lists an adopted release in the two places that enumerate every release:

    • the table of releases in docs/reference/versions.md, where the release takes the first open pair of cells, or a new row when the table has none;
    • the printed list under "Available schema versions" in docs/getting-started/core-tutorial.ipynb, where the release's tuple is appended.

    The command refuses a release that the installed idfkit does not list, and a second run changes nothing. Exit codes: 0 when both places list the release, 1 when the release cannot be listed, 2 when the arguments are wrong.

  3. tests/test_adopt_release.py: 6 tests against the committed pages, covering the open row, a full table, the appended tuple, idempotence, the refusal and a missing table.

3. Verification

  1. make check passes, with pyright reporting 0 errors, and the 6 new tests pass.
  2. The conformance caller check (caller_problems at governance-2026.25) reports no problem.
  3. Against the pinned library: 26.1.0 exits 0 and reports that both places already list it. 26.2.0 exits 1, because the installed idfkit does not list it.
  4. Not verified: a run of the workflow on GitHub. A caller can run only once it is on the default branch. In the roster, this project waits on a release of idfkit and of @idfkit/schemas that carries the release, so a dispatch before then reports waiting.

…pted release

The caller pins the reusable adoption workflow of idfkit-conformance at
governance-2026.25. The command adds the release to the table of releases and
to the tutorial's printed list of schema versions, refuses a release the
installed idfkit does not list, and changes nothing on a second run.
@github-actions

Copy link
Copy Markdown
Contributor

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

github-actions Bot added a commit that referenced this pull request Oct 14, 2026
@samuelduchesne
samuelduchesne merged commit 4c04a6d into main Oct 14, 2026
7 checks passed
@samuelduchesne
samuelduchesne deleted the adopt-energyplus branch October 14, 2026 12:33
github-actions Bot added a commit that referenced this pull request Oct 14, 2026
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