Skip to content

Conversation

@jcyuan2020
Copy link
Contributor

@jcyuan2020 jcyuan2020 commented Sep 19, 2024

Pull request overview

Before:
image

After:
image

NOTE: ENHANCEMENTS MUST FOLLOW A SUBMISSION PROCESS INCLUDING A FEATURE PROPOSAL AND DESIGN DOCUMENT PRIOR TO SUBMITTING CODE

Pull Request Author

Add to this list or remove from it as applicable. This is a simple templated set of guidelines.

  • Title of PR should be user-synopsis style (clearly understandable in a standalone changelog context)
  • Label the PR with at least one of: Defect, Refactoring, NewFeature, Performance, and/or DoNoPublish
  • Pull requests that impact EnergyPlus code must also include unit tests to cover enhancement or defect repair
  • Author should provide a "walkthrough" of relevant code changes using a GitHub code review comment process
  • If any diffs are expected, author must demonstrate they are justified using plots and descriptions
  • If changes fix a defect, the fix should be demonstrated in plots and descriptions
  • If any defect files are updated to a more recent version, upload new versions here or on DevSupport
  • If IDD requires transition, transition source, rules, ExpandObjects, and IDFs must be updated, and add IDDChange label
  • If structural output changes, add to output rules file and add OutputChange label
  • If adding/removing any LaTeX docs or figures, update that document's CMakeLists file dependencies

Reviewer

This will not be exhaustively relevant to every PR.

  • Perform a Code Review on GitHub
  • If branch is behind develop, merge develop and build locally to check for side effects of the merge
  • If defect, verify by running develop branch and reproducing defect, then running PR and reproducing fix
  • If feature, test running new feature, try creative ways to break it
  • CI status: all green or justified
  • Check that performance is not impacted (CI Linux results include performance check)
  • Run Unit Test(s) locally
  • Check any new function arguments for performance impacts
  • Verify IDF naming conventions and styles, memos and notes and defaults
  • If new idf included, locally check the err file and other outputs

@jcyuan2020 jcyuan2020 added the Defect Includes code to repair a defect in EnergyPlus label Sep 19, 2024
@nrel-bot
Copy link

@jcyuan2020 @Myoldmopar it has been 28 days since this pull request was last updated.

@mjwitte mjwitte added the OutputChange Code changes output in such a way that it cannot be merged after IO freeze label Oct 21, 2024
@mjwitte mjwitte changed the title Fix Issue #10286 window material shade eio output mis-alignment Fix Issue #10286 window material shade mis-alignment for Output:Constructions Oct 21, 2024
Copy link
Contributor

@mjwitte mjwitte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This works as advertised. The shift can also be seen in the Initialization Summary table report.

Before:
image

After:
image

I've added an entry to the Output Rules file and will push up shortly.

Thanks @jcyuan2020

@mjwitte
Copy link
Contributor

mjwitte commented Oct 21, 2024

Diffs are as expected. eio and table diffs in several files. This is ready to merge.

@Myoldmopar
Copy link
Member

The test failure there was purely because this is coming from a fork and there is still an issue with PRs from forks that have regressions. I need to resolve a conflict on here anyway, so maybe I'll take a look at that again before pushing up the resolved branch.

@Myoldmopar
Copy link
Member

OK, so that didn't work. This is a real challenge with the security in place. I'm not complaining, just trying to work through it. I definitely don't want to let external fork PRs slip regressions in, so without a comment ability, I think I need to have the regression workflow. A little more gracefully would be good though. I'll try one more tweak.

@Myoldmopar
Copy link
Member

OK, this might be a nice intermediate fix.

  • For PRs from branches inside this repo, it behaves like normal and reports the regressions right on the PR page
  • For PRs from forked repos, it skips that step since the action won't have write access to emit a comment here. Instead it will fail with a decently formatted message explaining that there were regressions, and hinting the reviewer to the job summary page.

If this behaves alright, we'll get this merged in. Sorry to hold up this fix while I worked out the GHA issue, but it was convenient to do this on an existing fork+diffs PR.

@jcyuan2020
Copy link
Contributor Author

No sure if the problem was due to a very outdated develop branch in the forked repo. Anyway I just updated the develop branch in the forked repo to see if that would help.

@Myoldmopar
Copy link
Member

@jcyuan2020 the Build and Test failure is actually occurring as intended. (Unfortunately) The details page quickly gets the reviewer to the reason why it failed: https://github.com/NREL/EnergyPlus/actions/runs/11845688475/job/33011694597?pr=10750#step:21:16, and then the job summary page has the regression bundle ready to download and inspect: https://github.com/NREL/EnergyPlus/actions/runs/11845688475?pr=10750.

The Windows failure appears unrelated. I kicked the Windows machine and deleted these test results to get a fresh run, and I expect this to merge in without any issue after that's done.

@Myoldmopar
Copy link
Member

Yep, this was all fine after the re-run of Windows. Merging this.

@Myoldmopar Myoldmopar merged commit 4a17be9 into NREL:develop Nov 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Defect Includes code to repair a defect in EnergyPlus OutputChange Code changes output in such a way that it cannot be merged after IO freeze

Projects

None yet

Development

Successfully merging this pull request may close these issues.

WindowMaterial:Shade eio output write-out CSV format typo

7 participants