Added Changelog

.circleci/config.yml

@@ -59,7 +59,16 @@ jobs:
             - run: |
                 source test_python/bin/activate
                 codecov
-
+
+  # TODO: Needs update after changelog format change
+  changelog_updated:
+    working_directory: ~/evalml
+    docker:
+      - image: docker:stable-git
+    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
@@ -84,3 +93,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/changelog.rst

@@ -1,6 +1,17 @@
-=========
+.. _changelog:
+.. TODO: Remove `<` and `>` to unhide
+
 Changelog
-=========
+---------
+**Future Releases**
 
-**v0.0.0**
-    * Initial Release
+    * Enhancements
+        *
+    * Fixes
+        *
+    * Changes
+        *
+    * Documentation Changes
+        * Added Changelog :pr:`‏‏‎<136>`
+    * Testing Changes
+        *

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,18 @@
 
 # -- Extension configuration -------------------------------------------------
 
+# If evalml is open-sourced: change empty string to '(GH#)' etc.
+# and also replace :pr:`‏‏‎<136>` as :pr:`136` 
+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>`.*