Added Changelog

.circleci/config.yml

@@ -63,7 +63,16 @@ jobs:
             - run: |
                 source test_python/bin/activate
                 codecov
-
+
+  changelog_updated:
+    working_directory: ~/evalml
+    executor:
+        name: python
+        python_version: "3.7"
+    steps:
+      - checkout
+      - run: echo "${CIRCLE_PULL_REQUEST##https://github.com/FeatureLabs/evalml/pull/}"
+      - run: cat docs/source/changelog.rst | grep ":pr:\`${CIRCLE_PULL_REQUEST##https://github.com/FeatureLabs/evalml/pull/}\`"
 
 workflows:
   version: 2
@@ -88,3 +97,8 @@ workflows:
           name: "python 3.7 unit tests"
           python_version: "3.7"
           codecov: true
+      - changelog_updated:
+          name: "changelog updated"
+          filters:
+            branches:
+              ignore: /^master?/

docs/source/_static/style.css

@@ -2,3 +2,7 @@
     display: none;
     opacity: 0
 }
+
+a[href^="https://github.com/Featurelabs/evalml/"] {
+    visibility: hidden;
+}

docs/source/changelog.rst

@@ -1,6 +1,68 @@
-=========
+.. _changelog:
+
 Changelog
-=========
+---------
+**Future Releases**
+    * Enhancements
+        * Added basic one hot encoding :pr:`73`
+        * Use enums for model_type :pr:`110`
+        * Support for splitting regression datasets :pr:`112`
+        * Auto-infer multiclass classification :pr:`99`
+        * Added support for other units in max_time :pr:`125`
+        * Detect highly null columns :pr:`121`
+        * Added additional regression objectives :pr:`100`
+    * Fixes
+        * Reordered `describe_pipeline` :pr:`94`
+        * Added type check for model_type :pr:`109`
+        * Fixed `s` units when setting string max_time :pr:`132`
+        * Fix objectives not appearing in API documentation :pr:`150`
+    * Changes
+        * Reorganized tests :pr:`93`
+        * Moved logging to its own module :pr:`119`
+        * Show progress bar history :pr:`111`
+    * Documentation Changes
+        * Update release instructions :pr:`140`
+        * Include additional_objectives parameter :pr:`124`
+        * Added Changelog :pr:`136`
+    * Testing Changes
+        * Code coverage pr:`90`
+        * Added CircleCI tests for other Python versions :pr:`104`
+        * Added doc notebooks as tests :pr:`139`
+        * Test metadata for CircleCI and 2 core parallelism :pr:`137`
+
+**v0.4.1 Sep. 16, 2019**
+    * Enhancements
+        * Added AutoML for classification and regressor using Autobase and Skopt :pr:`7` :pr:`9`
+        * Implemented standard classification and regression metrics :pr:`7`
+        * Added logistic regression, random forest, and XGBoost pipelines :pr:`7`
+        * Implemented support for custom objectives :pr:`15`
+        * Feature importance for pipelines :pr:`18`
+        * Serialization for pipelines :pr:`19`
+        * Allow fitting on objectives for optimal threshold :pr:`27`
+        * Added detect label leakage :pr:`31`
+        * Implemented callbacks :pr:`42`
+        * Allow for multiclass classification :pr:`21`
+        * Added support for additional objectives :pr:`79`
+    * Fixes
+        * Fixed feature selection in pipelines :pr:`13`
+        * Made random_seed usage consistent :pr:`45`
+    * Documentation Changes
+        * Documentation Changes
+        * Added docstrings :pr:`6`
+        * Created notebooks for docs :pr:`6`
+        * Initialized readthedocs EvalML :pr:`6`
+        * Added favicon :pr:`38`
+    * Testing Changes
+        * Added testing for loading data :pr:`39`
 
-**v0.0.0**
-    * Initial Release
+**v0.2.0 Aug. 13, 2019**
+    * Enhancements
+        * Created fraud detection objective :pr:`4`
+
+**v0.1.0 July. 31, 2019**
+    * *First Release* 
+    * Enhancements
+        * Added lead scoring objecitve :pr:`1`
+        * Added basic classifier :pr:`1`
+    * Documentation Changes
+        * Initialized Sphinx for docs :pr:`1`

docs/source/conf.py

@@ -48,6 +48,7 @@
     'sphinx.ext.autosummary',
     'sphinx.ext.napoleon',
     'sphinx.ext.viewcode',
+    'sphinx.ext.extlinks',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -189,11 +190,17 @@
 
 # -- Extension configuration -------------------------------------------------
 
+# If evalml is open-sourced: replace github specific style.css
+extlinks = {
+    'issue': ('https://github.com/Featurelabs/evalml/issues/%s', '#'),
+    'pr': ('https://github.com/Featurelabs/evalml/pull/%s', '#'),
+    'user': ('https://github.com/%s', '@')
+}
+
 autosummary_generate = ["api_reference.rst"]
 templates_path = ["_templates"]
 
+html_show_sphinx = False
+
 def setup(app):
     app.add_stylesheet("style.css")
-
-
-html_show_sphinx = False

docs/source/index.ipynb

@@ -382,6 +382,8 @@
    },
    "source": [
     "# Resources\n",
+    "[Changelog](changelog)\n",
+    "\n",
     "[Roadmap](roadmap)\n",
     "\n",
     "[API Reference](api_reference)"

pull_request_template.md

@@ -0,0 +1,5 @@
+### Pull Request Description
+(replace this text with your description)
+
+-----
+*After creating the pull request: in order to pass the **changelog_updated** check you will need to update the "Future Release" section of* `docs/source/changelog.rst` *to include this pull request by adding :pr:`<123>`.*