Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[MRG] DOC add documentation about Travis cron job #10124

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Nov 14, 2017
Merged

[MRG] DOC add documentation about Travis cron job #10124

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
82d5c5e
DOC add documentation about Travis cron job
lesteve Nov 13, 2017
c7adae8
Fix typos
lesteve Nov 13, 2017
7248153
Move wiki release link to the proper section
lesteve Nov 13, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 26 additions & 2 deletions doc/developers/maintainer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
Maintainer / core-developer information
========================================

For more information see https://github.com/scikit-learn/scikit-learn/wiki/How-to-make-a-release

Making a release
------------------
For more information see https://github.com/scikit-learn/scikit-learn/wiki/How-to-make-a-release


1. Update docs:

Expand Down Expand Up @@ -55,3 +55,27 @@ Making a release


7. FOR FINAL RELEASE: Update the release date in What's New

Travis Cron jobs
----------------

From `<https://docs.travis-ci.com/user/cron-jobs>`_: Travis CI cron jobs work
similarly to the cron utility, they run builds at regular scheduled intervals
independently of whether any commits were pushed to the repository. Cron jobs
always fetch the most recent commit on a particular branch and build the project
at that state. Cron jobs can run daily, weekly or monthly, which in practice
means up to an hour after the selected time span, and you cannot set them to run
at a specific time.

For scikit-learn, Cron jobs are used for builds that we do not want to run in
each PR. As an example the build with the dev versions of numpy and scipy is
run as a Cron job. Most of the time when this numpy-dev build fail, it is
related to a numpy change and not a scikit-learn one, so it would not make sense
to blame the PR author for the Travis failure.

The definition of what gets run in the Cron job is done in the .travis.yml
config file, exactly the same way as the other Travis jobs. We use a ``if: type
= cron`` filter in order for the build to be run only in Cron jobs.

The branch targetted by the Cron job and the frequency of the Cron job is set
via the web UI at https://www.travis-ci.org/scikit-learn/scikit-learn/settings.
Copy link
Member

Choose a reason for hiding this comment

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

Not sure but I might add something like "Currently, we run Cron job daily for master branch."

Copy link
Member Author

Choose a reason for hiding this comment

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

I tried to avoid "This is what we do currently" kind of information because in my experience they can become irrelevant/misleading reasonably quickly. Also in this case I think it is reasonably clear from https://www.travis-ci.org/scikit-learn/scikit-learn/settings which branch we run the Cron jobs on.

Copy link
Member

Choose a reason for hiding this comment

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

Thanks for the reply. I think you are right :)