Skip to content

Add update checker#2350

Merged
chukarsten merged 27 commits intomainfrom
2333_update_checker
Jun 21, 2021
Merged

Add update checker#2350
chukarsten merged 27 commits intomainfrom
2333_update_checker

Conversation

@jeff-hernandez
Copy link
Contributor

Closes #2333 by adding the Alteryx open-source update checker. The update checker will automatically check if there's a newer release of EvalML available.

@CLAassistant
Copy link

CLAassistant commented Jun 8, 2021

CLA assistant check
All committers have signed the CLA.

@codecov
Copy link

codecov bot commented Jun 8, 2021

Codecov Report

Merging #2350 (fdd50f6) into main (1111770) will not change coverage.
The diff coverage is 100.0%.

Impacted file tree graph

@@          Coverage Diff          @@
##            main   #2350   +/-   ##
=====================================
  Coverage   99.7%   99.7%           
=====================================
  Files        283     283           
  Lines      25233   25233           
=====================================
  Hits       25133   25133           
  Misses       100     100           
Impacted Files Coverage Δ
evalml/__init__.py 100.0% <100.0%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1111770...fdd50f6. Read the comment docs.

@jeff-hernandez jeff-hernandez marked this pull request as ready for review June 8, 2021 20:09
Copy link
Contributor

@angela97lin angela97lin left a comment

Choose a reason for hiding this comment

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

Just to make sure I understand the purpose of this: this is supposed to check that the packages evalml depends on are up to date? From the README, it sounded like it would automatically download the latest version of evalml but I tried to purposely downgrade evalml (to 0.24.0) an run python -m pip install evalml[update_checker] and nothing happened?

@gsheni
Copy link
Contributor

gsheni commented Jun 9, 2021

@angela97 this will only work once it is merged into main and released. In addition, it will only work with versions of EvalML going forward. The way this would work is the following.

  1. Have EvalML + updated checker installed
  2. New version of EvalML comes out
  3. The open-src-update-checker puts a warning in the console/output when you import evalml

@angela97lin angela97lin self-requested a review June 9, 2021 20:37
Copy link
Contributor

@angela97lin angela97lin left a comment

Choose a reason for hiding this comment

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

@gsheni Got it, thank you for explaining! I wonder if there's a clearer way to express this in the README, but otherwise this looks good! Thanks @jeff-hernandez for doing this 😁

@gsheni
Copy link
Contributor

gsheni commented Jun 16, 2021

@jeff-hernandez One thing I just realized, we should add this to the Install page

Copy link
Contributor

@dsherry dsherry left a comment

Choose a reason for hiding this comment

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

@jeff-hernandez looks great! One blocking change: please move the python code to evalml/utils/

I also left a comment for @freddyaboulton and @chukarsten to dig into--they've been working on our CI recently. But that's not blocking merge

@jeff-hernandez jeff-hernandez requested review from dsherry and gsheni June 17, 2021 18:12
Copy link
Contributor

@dsherry dsherry left a comment

Choose a reason for hiding this comment

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

Thanks @jeff-hernandez looks great! Left two docs nit-picks but not blocking merge

README.md Outdated
**Update checker** <br>
Receive automatic notifications of new EvalML releases
```
python -m pip install evalml[update_checker]
Copy link
Contributor

Choose a reason for hiding this comment

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

Mega nit-pick but elsewhere in our docs we say pip install ... instead of python -m pip install ...

"**Update checker** <br>\n",
"Receive automatic notifications of new EvalML releases\n",
"```\n",
"python -m pip install evalml[update_checker]\n",
Copy link
Contributor

Choose a reason for hiding this comment

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

Same nit-pick as above

Addressed comments
Addressed comments
@chukarsten chukarsten merged commit 81730da into main Jun 21, 2021
@chukarsten chukarsten deleted the 2333_update_checker branch June 21, 2021 14:40
@chukarsten chukarsten mentioned this pull request Jun 22, 2021
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.

Add alteryx_open_src_update_checker as an extras_require package

6 participants