Merge pull request #74 from glg/update-and-package

Publish as package.

Author: mikemartin1090

.github/workflows/node-js.yml

@@ -9,7 +9,7 @@ jobs:
       - uses: actions/checkout@master
       - uses: actions/setup-node@v2
         with:
-          node-version: 10
+          node-version: 16
       - name: npm install, lint, and test
         run: |
           npm ci

.github/workflows/release-please.yml

@@ -0,0 +1,40 @@
+on:
+  push:
+    branches:
+      - master
+      - main
+      - update-and-package
+
+name: release-please
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: google-github-actions/release-please-action@v3
+        id: release
+        with:
+          release-type: node
+          package-name: release-please-action
+
+      # The logic below handles the npm publication:
+      - uses: actions/checkout@v2
+        # these if statements ensure that a publication only occurs when
+        # a new release is created:
+        if: ${{ steps.release.outputs.release_created }}
+
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 16
+          registry-url: 'https://npm.pkg.github.com/'
+        if: ${{ steps.release.outputs.release_created }}
+
+      - run: npm ci
+        if: ${{ steps.release.outputs.release_created }}
+
+      - run: npm test
+        if: ${{ steps.release.outputs.release_created }}
+
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
+        if: ${{ steps.release.outputs.release_created }}

.nvmrc

@@ -0,0 +1 @@
+v16.17.0

.tool-versions

@@ -0,0 +1 @@
+nodejs 16.17.0

CONTRIBUTING.md

@@ -0,0 +1,24 @@
+## Primary Maintainer(s)
+
+- @drhayes - David Hayes
+- @mikemartin1090 - Mike Martin
+
+## How to Contribute
+
+We welcome any contributions that can help make this a more useful repository inner-source.  Contributions can include, but are not limited to:
+
+- Documentation improvements
+- Creating issues for bugs and participating when the solution/fix needs to be tested
+- Pull Requests for features, fixes, etc.
+
+## Formatting Commit Messages
+
+This repository uses conventional commits to format commit messages.  This allows us to automatically generate changelogs and release notes.  Please see [this link](https://www.conventionalcommits.org/en/v1.0.0/) for more information on how to format your commit messages.
+
+Specifically, we use the following format:
+
+- `feat: <description>` for new features
+- `fix: <description>` for bug fixes
+- `chore: <description>` for changes that don't affect the codebase
+
+One of those should be the first line in your commit message. If you need to add more detail, you can add a blank line and then add more detail.

readme.md README.mdreadme.md renamed to README.md

@@ -4,7 +4,7 @@ This is a good default configuration of [winston](https://github.com/winstonjs/w
 
 ## Install
 
-`npm install github:glg/node-logger`
+To install in your project, do `npm install github:glg/node-logger`.
 
 ## Usage
 
@@ -14,11 +14,11 @@ This is a good default configuration of [winston](https://github.com/winstonjs/w
 
 Params
 
-| Param | Type | Description | Default |
-|-|-|-|-|
-| logLevel | `String` | The minimum severity level to log. [See Log Levels](#log-levels) | `info`
-| metadata | `Object` | Any extra data you want included in your logging, like what service this is | `{}`
-| stderrLevels | `Array` | Which log levels should be logged to `stderr` instead of `stdout` | `[]`
+| Param        | Type     | Description                                                                 | Default |
+|--------------|----------|-----------------------------------------------------------------------------|---------|
+| logLevel     | `String` | The minimum severity level to log. [See Log Levels](#log-levels)            | `info`
+| metadata     | `Object` | Any extra data you want included in your logging, like what service this is | `{}`
+| stderrLevels | `Array`  | Which log levels should be logged to `stderr` instead of `stdout`           | `[]`
 
 ```javascript
 const { createLogger } = require('node-logger');
@@ -67,3 +67,9 @@ This supports the following log levels, in order of decreasing severity:
 If you create a logger with the log level `info` (default), it will log all outputs that are at least an `info` level severity, which would be everything except `debug`.
 
 If you create a logger with the log level `error`, it will only log messages that are `error`, `crit`, `alert`, or `emerg`.
+
+## Local development
+
+To work on this locally, clone it and run `npm install`. You should be good to go.
+
+Be sure to read CONTRIBUTING.md for guidelines on contributing to this repo.