Merge pull request #10 from jhomarolo/main

build(dependencies): update devdependencies and git actions dependencies

Author: jhomarolo

.eslintrc.json

@@ -10,9 +10,10 @@
     "Atomics": "readonly",
     "SharedArrayBuffer": "readonly"
   },
-  "parser": "babel-eslint",
+  "parser": "@babel/eslint-parser",
   "parserOptions": {
-    "ecmaVersion": 2018
+    "ecmaVersion": 2018,
+    "requireConfigFile": false
   },
   "rules": {
     "semi": ["error", "never"],

.github/CONTRIBUTING.md

@@ -0,0 +1,62 @@
+# Contributing
+
+:wave: Hi there!
+We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
+
+## Submitting a pull request
+
+[Pull Requests][pulls] are used for adding new playbooks, roles, and documents to the repository, or editing the existing ones.
+
+**With write access**
+
+1. Clone the repository (only if you have write access)
+1. Create a new branch: `git checkout -b my-branch-name`
+1. Make your change
+1. Push and [submit a pull request][pr]
+1. Pat yourself on the back and wait for your pull request to be reviewed and merged.
+
+**Without write access**
+
+1. [Fork][fork] and clone the repository
+1. Create a new branch: `git checkout -b my-branch-name`
+1. Make your change
+1. Push to your fork and [submit a pull request][pr]
+1. Pat your self on the back and wait for your pull request to be reviewed and merged.
+
+**Commit Structure**
+All the Herbs organization libraries uses seemantic release and commitizen to :
+
+- Generate changelog
+- Control version
+- Publish to npm via github actions
+Please use this format for commit messages (https://semver.org/).
+
+To help with this task we have implemented the commitizen to all libraries, just follow those steps:
+
+- `npm install -g commitizen`
+- Write a lot of good code to contribute to herbs 🌿
+- `git add yourChanges`
+- `git cz` or `npm run commit` or `npx cz` instead `git commit`
+- `git push`
+
+
+Here are a few things you can do that will increase the likelihood of your pull request being accepted:
+
+- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
+- Write [good commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+
+Draft pull requests are also welcome to get feedback early on, or if there is something blocking you.
+
+- Create a branch with a name that identifies the user and nature of the changes (similar to `user/branch-purpose`)
+- Open a pull request
+
+
+## Resources
+
+- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
+- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
+- [GitHub Help](https://help.github.com)
+
+[pulls]: https://github.com/herbsjs/herbs2mongo/pulls
+[pr]: https://github.com/herbsjs/herbs2mongo/compare
+[fork]: https://github.com/herbsjs/herbs2mongo/fork

.github/workflows/cd.yml

@@ -0,0 +1,41 @@
+name: CD Build
+
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  build:
+    if: "!contains(github.event.head_commit.message, 'skip ci')"
+    runs-on: ubuntu-18.04
+
+    strategy:
+      matrix:
+        node-version: [14.x]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ matrix.node-version }}
+
+    - name: Install Packages
+      run: npm ci
+
+    - name: Installing dependencies
+      run: npm i --ignore-scripts
+
+    - name: Build Step
+      env:
+        CI: ""
+      run: npm run build --if-present
+
+    - name: Running Linter - ESLint
+      run: npm run lint
+
+    - name: Run Semantic Release
+      run: npx semantic-release
+      env:
+        GH_TOKEN: ${{ secrets.GH_TOKEN }}
+        NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/ci.yml

@@ -1,40 +1,35 @@
-# 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: CI
+name: CI build
 
 on:
-  push:
-    branches: [ main ]
+  pull_request:
+    branches: [main]
 
 jobs:
   build:
-    if: "!contains(github.event.head_commit.message, 'skip ci')"
-    runs-on: ubuntu-18.04
-    steps:
-    - uses: actions/checkout@v2
-
-    - name: Use Node.js (12.16.2)
-      uses: actions/setup-node@v1
-      with:
-        node-version: '12.16.2'
+    runs-on: ubuntu-latest
 
-    - name: Install Packages
-      run: npm ci
+    strategy:
+      matrix:
+        node-version: [14.x]
 
-    - name: Installing dependencies
-      run: npm i --ignore-scripts
-
-    - name: Build Step
-      env:
-        CI: ""
-      run: npm run build --if-present
-
-    - name: Running Linter - ESLint
-      run: npm run lint
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Installing dependencies
+        run: npm i --ignore-scripts
+      - name: Running tests
+        run: |
+              npm test
+              npx nyc --reporter=lcov npm test && npx codecov
+        env:
+          CI: true
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v2
+
+      - name: Running Linter - ESLint
+        run: npm run lint
 
-    - name: Run Semantic Release
-      run: npx semantic-release
-      env:
-        GH_TOKEN: ${{ secrets.GH_TOKEN }}
-        NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/on_pull_request.yml

@@ -337,3 +337,9 @@ Tests:
 - [X] Pure JS
 - [X] MongoDB
 
+### Contribute
+Come with us to make an awesome *herbs2mongo*.
+
+Now, if you do not have the technical knowledge and also have intended to help us, do not feel shy, [click here](https://github.com/herbsjs/herbs2mongo/issues) to open an issue and collaborate their ideas, the contribution may be a criticism or a compliment (why not?)
+
+If you would like to help contribute to this repository, please see [CONTRIBUTING](https://github.com/herbsjs/herbs2mongo/blob/main/.github/CONTRIBUTING.md)