Skip to content

deprecation_checklist

Jump to bottom
Dave Fisher edited this page Dec 20, 2022 · 15 revisions

Deprecation Checklist

  • Remove the model's source code
    • git rm the model's source code from src/natcap/invest/
    • git rm the model's tests from tests/
    • git rm the model's UI file from src/natcap/invest/ui
    • git rm any related sections/pages from the InVEST API documentation at doc/api-docs
    • Remove references to the model in the workbench source code:
      • sampledata_registry.json
      • ResourcesLinks.jsx
      • ui_config.js
    • Edit the MODEL_METADATA dict in src/natcap/invest/__init__.py to remove the model's CLI entrypoints.
    • Remove the model from setup.py (not all models will need this)
  • Update the tests
    • git rm any test files and/or classes associated with the model
    • git rm any test data from invest-test-data repository and update Makefile with the new git rev.
    • Make sure the remaining tests run through!
  • Remove the model from the InVEST distribution
    • Update the sample data repository at data/invest-data:
      • Remove the model's directory from the repo.
      • Remove the model's entry from the ZIPDIRS list in Makefile if needed.
      • Update the Makefile with the new git revision.
    • Remove references in installer/windows/invest_installer.nsi (Start Menu links & Sample Data downloads)
    • Remove the model's datastack entry/entries from scripts/invest-autotest.py
    • Remove the user's guide chapter from the User's Guide repository and update the User's Guide revision in the Makefile accordingly.
  • Update HISTORY.rst to note the change.
  • Build the binaries to verify that everything builds correctly.
  • Do a pull request on all this!

When the source code is all set and PRed in,

Clone this wiki locally