Add publish CI, contributing docs, reduce files that get published (#74)

.github/workflows/node.js.yml → .github/workflows/ci.yml

@@ -1,34 +1,28 @@
-# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
-
-name: Node.js CI
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
-
-jobs:
-  build:
-
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [10.x, 12.x, 14.x]
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node-version }}
-    - run: npm i -g yarn
-    - run: yarn
-    - run: yarn build
-    - run: yarn reflect
-    - run: yarn isclean
-    - run: yarn lint
-    - run: yarn prettier
-    - run: yarn test
+name: Node.js CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [10.x, 12.x, 14.x]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: npm i -g yarn
+    - run: yarn
+    - run: yarn build
+    - run: yarn reflect
+    - run: yarn isclean
+    - run: yarn lint
+    - run: yarn prettier
+    - run: yarn test

.github/workflows/publish.yml

@@ -0,0 +1,26 @@
+name: Npm Publish
+
+on:
+  push:
+    tags:
+     - 'v:*'
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 14.x
+      - run: yarn
+      - run: yarn build
+      - run: yarn reflect
+      - run: yarn isclean
+      - run: yarn lint
+      - run: yarn prettier
+      - run: yarn test
+      - uses: JS-DevTools/npm-publish@v1
+        with:
+          token: ${{ secrets.NPM_TOKEN }}
+          dry-run: true # TODO remove this when feeling confident

CHANGELOG.md

@@ -1,34 +1,78 @@
-# Changelog
-
-This changelog is currently manually maintained. Please see commits, PRs and Issue discussions on GitHub for the latest and most correction information.
-
-### 5.0.0
-
-- Updated `calculateComplexity` signature, file extension and typescript/flow flags added
-
-### 4.0.1
-
-- Updated ts and npm config to properly expose types
-
-### 4.0.0
-
-- Added and exposed `calculateComplexity`
-- Refactored linting config
-- Removed more legacy config and code
-- Migrated to Jest
-- Fixed coverage
-
-### 3.0.0
-
-- Refactored available options
-- Made flow optional and disabled by default
-- Added GitHub pipeline config
-
-### 2.0.0
-
-- Removed lots of legacy/dead code that existed in 1.0.0
-- Migrated to TypeScript
-
-### 1.0.0
-
+# Changelog
+
+This changelog is currently manually maintained. Please see commits, PRs and Issue discussions on GitHub for the latest and most correction information.
+
+### 8.0.0
+
+- Added new tooling for automating publishing and releasing
+- Added contributing docs
+- Removed sources from the published build
+
+### 7.1.5
+
+- Removed the npm engine restriction
+
+### 7.1.0
+
+- Adds badges (#53)
+- Strengthen build process 
+- Convert tests to TypeScript (#55)
+- Adds the minimum threshold feature (#59)
+
+### 7.0.1
+
+- Add new results API (#49)
+- Fix lint and style errors, update CI to ensure lint and style errors can't be merged
+- Update CLI output to include longer filepaths and fix the formatting
+
+### 6.1.1
+
+- Allow config to exist in `package.json` instead of `codehawk.json`
+
+### 6.0.3
+
+- Update docs
+- Correct some logic around where the CLI is being executed
+
+### 6.0.1
+
+- Fix CLI bash context
+
+### 6.0.0
+
+- Added new CLI top level interface
+
+### 5.0.1
+
+- Correctly exposed types
+
+### 5.0.0
+
+- Updated `calculateComplexity` signature, file extension and typescript/flow flags added
+
+### 4.0.1
+
+- Updated ts and npm config to properly expose types
+
+### 4.0.0
+
+- Added and exposed `calculateComplexity`
+- Refactored linting config
+- Removed more legacy config and code
+- Migrated to Jest
+- Fixed coverage
+
+### 3.0.0
+
+- Refactored available options
+- Made flow optional and disabled by default
+- Added GitHub pipeline config
+
+### 2.0.0
+
+- Removed lots of legacy/dead code that existed in 1.0.0
+- Migrated to TypeScript
+
+### 1.0.0
+
 Initial release

CODE_OF_CONDUCT.md

@@ -0,0 +1,133 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+Community Impact Guidelines were inspired by 
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available 
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations