Skip to content

Update Pre-Commit and GH Actions Versions - #904

Merged
johnjasa merged 9 commits into
NatLabRockies:developfrom
RHammond2:update/infrastructure-versioning
Oct 6, 2026
Merged

johnjasa merged 9 commits into
NatLabRockies:developfrom
RHammond2:update/infrastructure-versioning

Conversation

@RHammond2

Copy link
Copy Markdown
Collaborator

Update Pre-Commit and GH Actions Versions

This PR is simply to provide some updates to the GH Actions versioning and to the versions of packages used in the pre-commit workflows as part of a routine maintenance update when I notice there have been updates to underlying systems. There are quite a few updates to the ruff defaults as we're jumping 8 minor versions (and 4 major in isort), so the automated updates and manual fixes are applied to a single commit to reduce clutter.

Section 1: Type of Contribution

  • Feature Enhancement
    • Framework
    • New Model
    • Updated Model
    • Tools/Utilities
    • Other (please describe):
  • Bug Fix
  • Documentation Update
  • CI Changes
  • Other (please describe): linting and formatting update with application of changes

Section 2: Draft PR Checklist

  • Open draft PR
  • Describe the feature that will be added
  • Fill out TODO list steps
  • Describe requested feedback from reviewers on draft PR
  • Complete Section 8: New Model Checklist (if applicable)

TODO:

  • Step 1
  • Step 2

Type of Reviewer Feedback Requested (on Draft PR)

Structural feedback:

Implementation feedback:

Other feedback:

Section 3: General PR Checklist

  • PR description thoroughly describes the new feature, bug fix, etc.
  • Added tests for new functionality or bug fixes
  • Tests pass (If not, and this is expected, please elaborate in the Section 6: Test Results)
  • Documentation
    • Docstrings are up-to-date
    • Related docs/ files are up-to-date, or added when necessary
    • Documentation has been rebuilt successfully
    • Examples have been updated (if applicable)
  • CHANGELOG.md
    • At least one complete sentence has been provided to describe the changes made in this PR
    • After the above, a hyperlink has been provided to the PR using the following format:
      "A complete thought. [PR XYZ]((https://github.com/NatLabRockies/H2Integrate/pull/XYZ)", where
      XYZ should be replaced with the actual number.

Section 4: Related Issues

N/A, regular maintenance update

Section 5: Impacted Areas of the Software

Section 5.1: New Files

N/A

Section 5.2: Modified Files

Most files have been modified to some degree to maintain adherence to the updated ruff/isort/pre-commit settings. Those changes will not be outlined here for the everyone's sanity. In addition they're all compiled into a single commit that's been added to the .git-blame-ignore-revs file to ensure only relevant changes are shown in git blame.

  • .github/workflows
    • ci.yml, publish_to_pypi.yml, publish_to_test_pypi.yml:
      • actions/checkout: v6 -> v7
      • actions/setup-python: v6 -> v7
    • ci.yml:
      • actions/checkout: v6 -> v7
      • conda-incubator/setup-miniconda: added channels to match environment.yml and suppress a raised warning/debug message in the Actions interface
  • pyproject.toml
    • remove deprecated ruff settings
    • ignore "A005" for now (overlapping h2i package resource and Python standard library resource)

Section 6: Additional Supporting Information

Section 7: Test Results, if applicable

Section 8 (Optional): New Model Checklist

  • Model Structure:
    • Follows established naming conventions outlined in docs/developer_guide/coding_guidelines.md
    • Used attrs class to define the Config to load in attributes for the model
      • If applicable: inherit from BaseConfig or CostModelBaseConfig
    • Added: initialize() method, setup() method, compute() method
      • If applicable: inherit from CostModelBaseClass
  • Integration: Model has been properly integrated into H2Integrate
    • Add the new model to the appropriate __init__.py file to ensure it is properly imported and used in supported_models.py
    • Added to supported_models.py
    • If a new commodity_type is added, update create_financial_model in h2integrate_model.py
  • Tests: Unit tests have been added for the new model
    • Pytest-style unit tests
    • Unit tests are in a "test" folder within the folder a new model was added to
    • If applicable add integration tests
  • Example: If applicable, a working example demonstrating the new model has been created
    • Input file comments
    • Run file comments
    • Example has been tested and runs successfully in test_all_examples.py
  • Documentation:
    • Write docstrings using the Google style
    • Model added to the main models list in docs/user_guide/model_overview.md
      • Model documentation page added to the appropriate docs/ section
      • <model_name>.md is added to the _toc.yml
    • Run generate_class_hierarchy.py to update the class hierarchy diagram in docs/developer_guide/class_structure.md

@RHammond2
RHammond2 requested a review from johnjasa October 6, 2026 16:44
@RHammond2 RHammond2 added the infrastructure Anything relating to CI, project management, or non-code changes label Oct 6, 2026

@johnjasa johnjasa left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks for this, @RHammond2! and for handling some of these last changes by hand too. I'm good with just ignoring the package name clash for now, don't even need an issue imo, can tackle it if/when we see fit.

@johnjasa
johnjasa enabled auto-merge October 6, 2026 21:18
@johnjasa
johnjasa merged commit 81c841e into NatLabRockies:develop Oct 6, 2026
12 checks passed
@RHammond2
RHammond2 deleted the update/infrastructure-versioning branch October 6, 2026 21:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

infrastructure Anything relating to CI, project management, or non-code changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants