release @elastic/[email protected] (#171)

Also add a doc for how to release/publish packages in this repo.

Author: trentm

CONTRIBUTING.md

@@ -50,16 +50,3 @@ Once your changes are ready to submit for review:
     but we'll do our best to dedicate it the attention it deserves.
     Your effort is much appreciated!
 
-### Releasing
-
-If you have access to make releases, the process is as follows:
-
-1. Update the version in `package.json` according to the scale of the change
-   (major, minor or patch).
-1. Update the corresponding "CHANGELOG.md".
-1. Commit changes with message `Bumped vx.y.z` where `x.y.z` is the version in
-   "package.json".
-1. Wait for CI to finish running the test.
-1. Publish to npm with `npm publish` *(see
-   [publish](https://docs.npmjs.com/cli/publish) and
-   [dist-tag](https://docs.npmjs.com/cli/dist-tag) docs)*

RELEASING.md

@@ -0,0 +1,79 @@
+# How to release the ecs-logging-nodejs packages in this repo
+
+There are two types of packages in this repo:
+
+1. The `@elastic/ecs-helpers` utility package that is used by the others, and
+2. the `@elastic/ecs-[...]-format` packages for supported logging frameworks
+   that are meant to be used by end users.
+
+The ecs-helpers utility is versioned, released, and tagged independently from
+the others.
+
+## Releasing `@elastic/ecs-helpers`
+
+Assuming "x.y.z" is the release version:
+
+1. Choose the appropriate version number according to semver.
+2. Create a PR that:
+    - bumps the "version" in "packages/ecs-helpers/package.json",
+    - updates "packages/ecs-helpers/CHANGELOG.md", if necessary, and
+    - is named something like "release @elastic/ecs-helpers@x.y.z", if the PR
+      is only about doing the release. (If this PR is also related to other
+      changes, then the commit/PR title should include mention of those
+      things as well.)
+3. Get the PR approved and merged.
+4. Tag the commit as follows, in a git clone with the merged commit:
+    ```
+    git tag ecs-helpers-vx.y.z
+    git push origin ecs-helpers-vx.y.z
+    ```
+5. Publish to npm, in a clean git clone:
+    ```
+    git status              # this should show "working tree clean"
+    cd packages/ecs-helpers
+    npm publish
+    ```
+
+## Releasing `@elastic/ecs-[...]-format`
+
+1. Choose the appropriate version number. All `ecs-*-format` packages currently
+   coordinate their versions. That means that if "1.2.3" is the current latest
+   release of any those packages, then the next release version of any of
+   them is after that. Use `git tag -l` to list current versions.
+
+   For example, if the latest versions are [email protected] and
+   [email protected], and a new release only for ecs-morgan-format
+   is being done, then the next version should be:
+    - `1.2.4` for a patch-level release,
+    - `1.3.0` for a minor-level release, or
+    - `2.0.0` for a major-level release
+
+   This is a bit weird for some cases, but allows use to have a simple `vx.y.z`
+   tag for referring to the source code for any published release.
+
+2. Create a PR that:
+    - bumps the "version" in "packages/ecs-[...]-format/package.json",
+    - updates "packages/ecs-[...]-format/CHANGELOG.md", if necessary, and
+    - is named something like "release vx.y.z" if all format packages are
+      being released or "release @elastic/[email protected]" if just
+      one of them is being released.
+   (If this PR is also related to other changes, then the commit/PR title
+   should include mention of those things as well.)
+
+3. Get the PR approved and merged.
+
+4. Tag the commit as follows, in a git clone with the merged commit:
+    ```
+    git tag vx.y.z
+    git push origin vx.y.z
+    ```
+
+5. Publish to npm, in a clean git clone:
+    ```
+    git status              # this should show "working tree clean"
+
+    # for each of the packages being released:
+    cd packages/ecs-...-format
+    npm publish
+    ```
+

packages/ecs-morgan-format/CHANGELOG.md

@@ -1,5 +1,10 @@
 # @elastic/ecs-morgan-format Changelog
 
+## v1.5.1
+
+- Fix types -- "index.d.ts" had not been included in the published package.
+  (by @imusvesh in https://github.com/elastic/ecs-logging-nodejs/pull/170)
+
 ## v1.5.0
 
 - Switch to `safe-stable-stringify` for JSON serialization. This library

packages/ecs-morgan-format/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elastic/ecs-morgan-format",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "description": "A formatter for the morgan logger compatible with Elastic Common Schema.",
   "main": "index.js",
   "types": "index.d.ts",