Release 2.0 (#50)

* Bump to version 2.0.0
* Updated changelog to v2.0.0
* Add upgrading docs

Author: patch0

CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [v2.0.0]
+
 ### Added
 - Added dummy route for `/auth/rpi` to add path helper `rpi_auth_login` (#44)
 - Request and routing specs inside the "dummy" testing app (#44)
@@ -67,6 +69,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - callback, logout and failure routes to handle auth
 
 [Unreleased]: https://github.com/RaspberryPiFoundation/rpi-auth/compare/v1.4.0...HEAD
+[v2.0.0]: https://github.com/RaspberryPiFoundation/rpi-auth/releases/tag/v2.0.0
 [v1.4.0]: https://github.com/RaspberryPiFoundation/rpi-auth/releases/tag/v1.4.0
 [v1.3.0]: https://github.com/RaspberryPiFoundation/rpi-auth/releases/tag/v1.3.0
 [v1.2.1]: https://github.com/RaspberryPiFoundation/rpi-auth/releases/tag/v1.2.1

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rpi_auth (1.4.0)
+    rpi_auth (2.0.0)
       omniauth-rails_csrf_protection (~> 1.0.0)
       omniauth-rpi (~> 1.4.0)
       rails (>= 6.1.4)

README.md

@@ -102,8 +102,6 @@ There is also a helper for the logout route:
 link_to 'Log out', rpi_auth_logout_path
 ```
 
-### Sin
-
 ### Redirecting users to the "next step"
 
 There are a three possible places the user will end up at following logging in,
@@ -152,6 +150,13 @@ class in `config/application.rb`.
 config.railties_order = [RpiAuth::Engine, :main_app, :all]
 ```
 
+## Upgrading between versions.
+
+This project follows semantic versioning, so upgrades between minor and patch
+versions should not need any code or configuration changes.
+
+For major version upgrades see the [upgrading docs](UPGRADING.md).
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

UPGRADING.md

@@ -0,0 +1,18 @@
+# Upgrading rpi-auth
+
+Here are the details of the changes needed when upgrading between major versions of this gem.
+
+## v1 to v2
+
+Definitely change the following:
+
+1. [ ] Replace references to `RpiAuth::AuthenticationHelper` with `RpiAuth::Controllers::CurrentUser`.
+2. [ ] Change `extend RpiAuth::Models::Authenticatable` to `include RpiAuth::Models::Authenticatable`.
+
+You might also need to;
+
+* [ ] Remove dummy `login` route in `/config/routes.rb`, and replace references to `login_path` with `rpi_auth_login_path`.
+* [ ] Change [the railties order](https://github.com/RaspberryPiFoundation/rpi-auth/blob/v2.0.0/README.md#globbedcatch-all-routes) if your app uses globbed/catch-all routes
+
+
+

lib/rpi_auth/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RpiAuth
-  VERSION = '1.4.0'
+  VERSION = '2.0.0'
 end