Maintenance: Update CI Workflows #500
Open
+17
−94
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update CI workflows for latest versions
This PR updates the GitHub Actions workflows to remove now unnecessary runners (GH Pages and CI Docs) and updates the remaining runners to ensure their actions versions are the latest with updates to Python versioning where applicable. Some other updates have been made to fully utilize existing runners and remove functionality that is out of date.
Section 1: Type of Contribution
Section 2: Draft PR Checklist
TODO:
Type of Reviewer Feedback Requested (on Draft PR)
Structural feedback:
Implementation feedback:
Other feedback:
Section 3: General PR Checklist
docs/files are up-to-date, or added when necessaryCHANGELOG.mdhas been updated to describe the changes made in this PRSection 3: Related Issues
N/A
Section 4: Impacted Areas of the Software
Section 4.1: New Files (N/A)
path/to/file.extensionmethod1: What and why something was changed in one sentence or less.Section 4.2: Modified Files
.github/workflows/ci_docs.yml: Removed because of the addition of a RTD-based docs builder on PRs..github/workflows/gh_pages.yml: Removed since RTD is preferenced for the docs..github/workflows/pre-commit.yml: Adds the runner to all PRs on develop and main to ensure consistent code in the primary working branches. Updates the actions and Python versions..github/workflows/ci.yml: Removesflake8in favor of thepre-commitworkflow. Updates the actions and Python versions..github/workflows/publish_to_pypi.yml: Updates the actions and Python versions..github/workflows/publish_to_test_pypi.yml: Updates the actions and Python versions.Section 5: Additional Supporting Information
This is partially prompted by the addition of a Read The Docs build step that was recently added, otherwise these are items I noticed while checking in on the current workflows.
Section 6: Test Results, if applicable
N/A
Section 7 (Optional): New Model Checklist
docs/developer_guide/coding_guidelines.mdattrsclass to define theConfigto load in attributes for the modelBaseConfigorCostModelBaseConfiginitialize()method,setup()method,compute()methodCostModelBaseClasssupported_models.pycreate_financial_modelinh2integrate_model.pytest_all_examples.pydocs/user_guide/model_overview.mddocs/section<model_name>.mdis added to the_toc.yml