README.md in nulogy_sso-2.1.3 vs README.md in nulogy_sso-2.2.0

- old
+ new

@@ -109,21 +109,29 @@ ### Testing Tests must be run manually before submitting a PR. This can be done using `rspec spec`. -There are multiple helpers made available via the `NulogySSO::TestUtilities` module. These are helpful for doing things such as grabbing test JWT values and interacting with a [Mockserver](https://github.com/jamesdbloom/mockserver) mock of the Auth0 API. +Please consult [this documentation](docs/Testing.md) for advice on how to implement tests on an application using nulogy_sso. -It is a common use case for a Rails app to switch from Devise-powered authentication to Auth0. This would also require updates to test helper code, similar to [functionality that Devise provides out of the box](https://github.com/heartcombo/devise/wiki/How-To:-Test-controllers-with-Rails-(and-RSpec)). [See this example](https://github.com/nulogy/Common-Platform-Interface/blob/f9444ded80d6012b9659942481fa2e6b880b54ee/spec/support/controller_integration_spec_macros.rb) of how a test helper could be written for an app using a feature flag (e.g. environment variable) to switch between Devise and NulogySSO authentication. +### Deployment -### - 1. Ensure that all tests are passing on the project 1. Increment the library version in [version.rb](./lib/nulogy_sso/version.rb), adhering to semver principles 1. Add a entry to [the Changelog](./CHANGELOG.md). Move all entries in the _Unreleased_ section into the new version's section. Now is also a good chance to add in any addition bullet points that may have been forgotten in the _Unreleased_ section. Append today's date to the new version. -1. Run these commands to complete the deployment. Rubygem push rights on this gem is required. +1. Run these commands to complete the deployment. Rubygem push rights on this gem is required. Obviously, replace `X.Y.Z` with the version being deployed. ```sh - gem build + # Commit changes to the files listed above + git commit -m "Cuts version X.Y.Z" + git push + + # Push the gem to Rubygems + gem build nulogy_sso.gemspec + gem push nulogy_sso-X.Y.Z.gem + + # Cut a release on GitHub + git tag vX.Y.Z + git push --tags ``` ### Contributing Feel free to create a PR if you wish to add new functionality to this Engine or detect a bug. A developer on CN1 will review and merge.