Add a CHANGELOG (#4260)

* add CHANGELOG

* add CI check to ensure CHANGELOG updated

* update comments

* fix

* actually fix

* actually, actually fix

* dont need upstream

* try checkout v1

* update

* add comment

* Format a little prettier

.github/workflows/pull_request.yml

@@ -6,6 +6,24 @@ on:
     - master
 
 jobs:
+  changelog:
+    name: CHANGELOG
+    runs-on: ubuntu-latest
+
+    steps:
+    # Note that checkout@v2 will not work with the git command below!
+    - uses: actions/checkout@v1
+
+    - name: Debugging info
+      run: |
+        git remote -v
+
+    - name: Check that CHANGELOG has been updated
+      run: |
+        # If this step fails, this means you haven't updated the CHANGELOG.md
+        # file with notes on your contribution.
+        git diff --name-only $(git merge-base origin/master HEAD) | grep '^CHANGELOG.md$' && echo "Thanks for helping keep our CHANGELOG up-to-date!"
+
   gpu_checks:
     name: GPU Checks
     runs-on: [self-hosted, GPU]

CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+### Fixed
+
+- Make `cached_path` work offline.
+- Tons of docstring inconsistencies resolved.
+- Nightly builds no longer run on forks.
+
+### Added
+
+- Additional CI checks to ensure docstrings are consistently formatted.
+
+## [v1.0.0rc4](/~https://github.com/allenai/allennlp/releases/tag/v1.0.0rc4) - 2019-05-14
+
+We first introduced this `CHANGELOG` after release `v1.0.0rc4`, so please refer to the GitHub release
+notes for this and earlier releases.

CONTRIBUTING.md

@@ -35,6 +35,8 @@ Make sure you have a clear description of the problem and the solution, and incl
 
 Our build system also calculates test coverage on every master commit.  Please add unit tests so we maintain our high coverage.
 
+Finally, please update the [CHANGELOG](./CHANGELOG.md) with notes on your fix in the "Unreleased" section.
+
 ### Do you have a suggestion for an enhancement?
 
 We use GitHub issues to track enhancement requests.  Before you create an enhancement request:

RELEASE_PROCESS.md

@@ -16,7 +16,7 @@ Then you can copy and paste the commands below without worrying about mistyping
 
 ## Steps
 
-1. Update `allennlp/version.py` (if needed) with the correct version and then commit and push the changes with:
+1. Update `allennlp/version.py` (if needed) with the correct version and the `CHANGELOG.md` so that everything under the "Unreleased" section is now under a section corresponding to this release. Then commit and push these changes with:
 
     ```
     git commit -a -m "Update version for release $TAG"
@@ -38,7 +38,7 @@ Then you can copy and paste the commands below without worrying about mistyping
     ```
 
 4. Find the tag you just pushed [on GitHub](/~https://github.com/allenai/allennlp/tags) and
-click edit. Then add some release notes including the commit history since the last release which you can get with
+click edit. Now copy over the latest section from the `CHANGELOG.md`. And finally, add a section called "Commits" with the output from this:
 
     ```bash
     git log `git describe --always --tags --abbrev=0 HEAD^^`..HEAD^ --oneline
@@ -47,8 +47,10 @@ click edit. Then add some release notes including the commit history since the l
     Or, if you're using fish,
 
     ```fish
-   git log (git describe --always --tags --abbrev=0 HEAD^^)..HEAD^ --oneline
-   ```
+    git log (git describe --always --tags --abbrev=0 HEAD^^)..HEAD^ --oneline
+    ```
+
+    On a Mac, for example, you can just pipe the above command into `pbcopy`.
 
 5. Click "Publish Release", and if this is a pre-release make sure you check that box.