Release prep

docs/contributing.md

@@ -8,29 +8,40 @@ For general documentation, see the [Udaru Website](<https://nearform.github.io/u
 
 ## Core committers - how to release
 
-It's a good idea to check that you have the latest version of npm installed before creating a new release. We are using npm shrinkwrap for releases and its behavior has been evolving. `npm install npm -g`
+It's a good idea to check that you have the latest version of npm installed before creating a new release: `npm install npm -g`
 
-We are currently supporting node 6.
+Udaru consists of 4 individual packages. While they are all published in their own independent lifecycle, they are also dependencies between them:
+
+* `@nearform/udaru-core`
+* `@nearform/udaru-hapi-plugin` (depends on `udaru-core`)
+* `@nearform/udaru-hapi-16-plugin` (depends on `udaru-core`)
+* `@nearform/udaru-hapi-server` (depends on `udaru-hapi-16-plugin`)
+
+Be mindful of these dependencies when publishing, i.e. if you publish a new version of `udaru-core` you need to bump all the other packages also.
+
+We are currently supporting node 6 and 8.
 
 1.  Review github issues, triage, close and merge issues related to the release.
 2.  Update the CHANGES.md file.
 3.  Navigate to the [Test Rig][Test] and ensure all tests are passing.
 4.  Pull down the repository locally on the master branch.
 5.  Ensure there are no outstanding commits and the branch is clean.
-6.  Run `npm install` and verify that root level and package dependencies correctly install.
-7.  Run `npm run outdated:all` and review all dependencies.
-8.  Run `npm run update:all` to get all non breaking updates. We have a policy of using '^' for all dependencies in the package.json and using npm shrinkwrap for each release.
-9.  Run `npm run outdated:all` again to review possible breaking and major revision updates.
-10. Create a github issue for any major update where appropriate.
-11. Run `npm test:commit-check` and ensure testing and linting passes, and that there are no dependency issues.
-12. Run `npm shrinkwrap`.
-13. Run `npm run swagger-gen` to regenerate the Swagger documentation for the Udaru [documentation site][docs-site].
-14. Run `git add` and `git commit` to commit any version and documentation changes if there are any.
-15. Run `lerna publish` and choose the approriate version change type.  This will update each  package.json of modified packages as appropriate, create a new git commit and tag, and publish updated packages to npm.
-16. Go to the [Github release page][Releases] and hit 'Draft a new release'.
-17. Paste the Changelog content for this release and add additional release notes.
-18. Choose the tag version and a title matching the release and publish.
-19. Notify core maintainers of the release via email.
+6.  From root, run `npm test:commit-check` and sanity check testing and linting passes, and that there are no dependency issues.
+7.  From root, run `npm run outdated:all` and review all dependencies. For each outdated dependency, make a call whether to update or not.
+    -    Run `npm run update:all` to get all non breaking updates. We have a policy of using '^' for all dependencies in the package.json and using npm shrinkwrap for each release.
+    -    Run `npm run outdated:all` again to review possible breaking and major revision updates.
+    -    Create a github issue for any major update where appropriate.
+8.  In the order of dependencies above, for each package:
+    -   Run `npm install` and verify that root level and package dependencies correctly install.
+    -   Run `npm test` to verify the tests run locally within their own context (something that's not done by CI)
+9.  For the `udaru-hapi-server` package only, run `npm shrinkwrap`.
+10. Run `npm run swagger-gen` to regenerate the Swagger documentation for the Udaru [documentation site][docs-site].
+    -   Run `git add` and `git commit` to commit any version and documentation changes if there are any.
+11. Finally, from root, run `lerna publish` and choose the approriate version change type.  This will update each  package.json of modified packages as appropriate, create a new git commit and tag, and publish updated packages to npm.
+12. Go to the [Github release page][Releases] and hit 'Draft a new release'.
+13. Paste the Changelog content for this release and add additional release notes.
+14. Choose the tag version and a title matching the release and publish.
+15. Notify the #udaru slack channel
 
 [Test]: https://travis-ci.org/nearform/udaru
 [Releases]: https://github.com/nearform/udaru/releases

package.json

@@ -141,8 +141,8 @@
   "dependencies": {},
   "devDependencies": {
     "depcheck": "^0.6.9",
-    "joi": "^13.1.2",
-    "lerna": "^2.9.0",
+    "joi": "^13.2.0",
+    "lerna": "^2.11.0",
     "remark-cli": "^5.0.0",
     "remark-lint": "^6.0.1",
     "remark-preset-lint-recommended": "^3.0.1",

packages/udaru-core/package.json

@@ -105,7 +105,6 @@
     "user management",
     "acl"
   ],
-
   "main": "index.js",
   "bin": {
     "udaru-migrate": "./database/migrate.js",
@@ -125,7 +124,7 @@
     "@nearform/sql": "^1.0.1",
     "async": "^2.6.0",
     "boom": "^7.2.0",
-    "joi": "^13.1.2",
+    "joi": "^13.2.0",
     "jsonfile": "^4.0.0",
     "lodash": "^4.17.5",
     "pbac": "^0.3.0",

packages/udaru-hapi-16-plugin/package.json

@@ -122,7 +122,7 @@
     "boom": "^7.2.0",
     "hapi": "^16.6.2",
     "hoek": "^5.0.3",
-    "joi": "^13.1.2",
+    "joi": "^13.2.0",
     "lodash": "^4.17.5"
   },
   "devDependencies": {

packages/udaru-hapi-plugin/package.json

@@ -123,7 +123,7 @@
     "boom": "^7.2.0",
     "hapi": "^17.2.3",
     "hoek": "^5.0.3",
-    "joi": "^13.1.2",
+    "joi": "^13.2.0",
     "lodash": "^4.17.5"
   },
   "devDependencies": {