Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove Everest restart functionality #8809

Merged
merged 2 commits into from
Sep 30, 2024
Merged

Remove Everest restart functionality #8809

merged 2 commits into from
Sep 30, 2024

Conversation

verveerpj
Copy link
Contributor

@verveerpj verveerpj commented Sep 27, 2024

Issue
The restart functionality was original added to support a research project. It turned out to be unnecessary. Since features should not be added for such a purpose and it is not clear if the feature is useful in this form, it should be removed. To my knowledge it is unused and removal will have no impact on users, but should still be categorized as such in the release notes.

Approach

  • Update the documentation generator, which was broken

  • Remove the restart functionality from the configuration and the code

  • Remove the related tests

  • Rewrite and rename a test that was using the functionality

  • PR title captures the intent of the changes, and is fitting for release notes.

  • Added appropriate release note label

  • Commit history is consistent and clean, in line with the contribution guidelines.

  • Make sure unit tests pass locally after every commit (git rebase -i main --exec 'pytest tests/ert/unit_tests -n logical -m "not integration_test"')

When applicable

  • When there are user facing changes: Updated documentation
  • New behavior or changes to existing untested code: Ensured that unit tests are added (See Ground Rules).
  • Large PR: Prepare changes in small commits for more convenient review
  • Bug fix: Add regression test for the bug
  • Bug fix: Create Backport PR to latest release

@verveerpj verveerpj added payback release-notes:user-impact Automatically categorise as breaking for people using CLI/GUI everest labels Sep 27, 2024
@verveerpj verveerpj self-assigned this Sep 27, 2024
@verveerpj verveerpj changed the title Everest remove restart functionality Remove Everest restart functionality Sep 27, 2024
@codecov-commenter
Copy link

codecov-commenter commented Sep 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.37%. Comparing base (321767c) to head (12b6829).

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #8809   +/-   ##
=======================================
  Coverage   91.36%   91.37%           
=======================================
  Files         342      342           
  Lines       20995    20995           
=======================================
+ Hits        19183    19184    +1     
+ Misses       1812     1811    -1     
Flag Coverage Δ
cli-tests 39.62% <ø> (+<0.01%) ⬆️
gui-tests 73.50% <ø> (ø)
performance-tests 50.10% <ø> (+0.01%) ⬆️
unit-tests 79.84% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@verveerpj verveerpj force-pushed the everest-remove-restart branch from 02091d4 to bba48bc Compare September 27, 2024 11:27
The restart functionality was added to support a research project.
However it turned out to be unnecessary for that project. Since
functionality should not be added for such a purpose only and the
general usefulness of the feature is unclear it should be removed.
@verveerpj verveerpj force-pushed the everest-remove-restart branch from bba48bc to 12b6829 Compare September 27, 2024 11:36
Copy link
Contributor

@DanSava DanSava left a comment

Choose a reason for hiding this comment

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

LGTM 🔪

@verveerpj verveerpj merged commit 03d3f9b into main Sep 30, 2024
51 checks passed
@verveerpj verveerpj deleted the everest-remove-restart branch September 30, 2024 06:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
everest payback release-notes:user-impact Automatically categorise as breaking for people using CLI/GUI
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants