Skip to content

Fix comstock workflow generator version bug#487

Open
rajeee wants to merge 8 commits into
developfrom
com_workflow_fix
Open

Fix comstock workflow generator version bug#487
rajeee wants to merge 8 commits into
developfrom
com_workflow_fix

Conversation

@rajeee

@rajeee rajeee commented Mar 25, 2025

Copy link
Copy Markdown
Collaborator

Fixes #486.

Pull Request Description

Fix the missing ComStock WokflowGenerator version 2024.07.18 definition.

Checklist

Not all may apply

  • Code changes (must work)
  • Tests exercising your feature/bug fix (check coverage report on Checks -> BuildStockBatch Tests -> Artifacts)
  • Coverage has increased or at least not decreased. Update minimum_coverage in .github/workflows/coverage.yml as necessary.
  • All other unit and integration tests passing
  • Update validation for project config yaml file changes
  • Update existing documentation
  • Run a small batch run on Kestrel to make sure it all works if you made changes that will affect Kestrel
  • Add to the changelog_dev.rst file and propose migration text in the pull request

@github-actions

Copy link
Copy Markdown

Code Coverage

Package Line Rate Complexity Health
. 84% 0
cloud 86% 0
sampler 58% 0
test 93% 0
workflow_generator 95% 0
workflow_generator.commercial 100% 0
workflow_generator.commercial.latest 73% 0
workflow_generator.commercial.v2024_07_18 73% 0
workflow_generator.residential 100% 0
workflow_generator.residential.latest 93% 0
workflow_generator.residential.latest.tests 100% 0
workflow_generator.residential.v2024_07_18 91% 0
workflow_generator.residential.v2024_07_18.tests 99% 0
workflow_generator.residential.v2024_07_19 70% 0
workflow_generator.residential.v2024_07_19.tests 99% 0
workflow_generator.residential.v2024_07_20 70% 0
workflow_generator.residential.v2024_07_20.tests 100% 0
workflow_generator.residential.v2025_01_29 70% 0
workflow_generator.residential.v2025_01_29.tests 100% 0
workflow_generator.residential.v2025_02_25 70% 0
workflow_generator.residential.v2025_02_25.tests 100% 0
Summary 87% (5915 / 6784) 0

Minimum allowed line rate is 33%

@rajeee rajeee requested a review from Copilot May 13, 2025 22:56

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull Request Overview

This PR fixes an issue with the ComStock WorkflowGenerator version by adding the missing definition for version 2024.07.18 and updating error messages to list available versions.

  • Added a mapping for commercial_v2024_07_18 in the version info dictionary
  • Updated error messages to convert version keys to a list for clarity

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
buildstockbatch/workflow_generator/init.py Added missing mapping for commercial_v2024_07_18 version info
buildstockbatch/base.py Updated error messages to display available version keys clearly
Comments suppressed due to low confidence (3)

buildstockbatch/base.py:839

  • Including the available versions in the error message is helpful; ensure that this format is consistent with similar validations to avoid potential confusion.
raise ValidationError( ... f"Available versions: {list(workflow_generator.version2info[wg_type].keys())}" ... )

buildstockbatch/workflow_generator/init.py:52

  • Ensure that 'commercial_v2024_07_18' is correctly imported and its version attribute is unique, helping avoid potential key conflicts in the version mapping.
commercial_v2024_07_18.__version__: commercial_v2024_07_18.version_info,

buildstockbatch/base.py:91

  • Converting the available version keys to a list improves clarity; confirm that this format meets end–user expectations and maintains consistency with similar error messages.
f"Available versions are {list(workflow_generator.version2GeneratorClass[generator_type].keys())}"

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.

BSB fails on ComStock run

3 participants