Release v8.0.3 (#56)

- ci: only publish when package.json modified - populate [files] in package.json. Delete .npmignore. - move templates into directory - dep: eslint-plugin-haraka -> @haraka/eslint-config - update 'lint' script in package.json - chore: prettier automated code formatting - doc: added CONTRIBUTORS - doc: Changes -> CHANGELOG
haraka · Aug 24, 2024 · 7e83d34 · 7e83d34
1 parent a08a36b
commit 7e83d34
Show file tree

Hide file tree

Showing 20 changed files with 1,715 additions and 1,765 deletions.
diff --git a/.codeclimate.yml b/.codeclimate.yml
@@ -1,13 +1,13 @@
 engines:
   eslint:
     enabled: true
-    channel: "eslint-6"
+    channel: 'eslint-6'
     config:
-      config: ".eslintrc.yaml"
+      config: '.eslintrc.yaml'
 
 ratings:
-   paths:
-   - "**.js"
+  paths:
+    - '**.js'
 
 checks:
   return-statements:
@@ -22,4 +22,4 @@ checks:
       threshold: 45
   method-complexity:
     config:
-      threshold: 6
+      threshold: 6
diff --git a/.eslintrc.yaml b/.eslintrc.yaml
@@ -2,17 +2,9 @@ env:
   node: true
   es6: true
   mocha: true
+  es2022: true
 
-plugins: [ haraka ]
+extends: '@haraka'
 
-extends: [ eslint:recommended, plugin:haraka/recommended ]
-
-root: true
-
-globals:
-  OK: true
-  CONT: true
-  DENY: true
-  DENYSOFT: true
-  DENYDISCONNECT: true
-  DENYSOFTDISCONNECT: true
+rules:
+  no-unused-vars: 0
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -2,9 +2,9 @@
 
 version: 2
 updates:
-  - package-ecosystem: "npm"
-    directory: "/"
+  - package-ecosystem: 'npm'
+    directory: '/'
     schedule:
-      interval: "weekly"
+      interval: 'weekly'
     allow:
       - dependency-type: production
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,12 +1,11 @@
 name: CI
 
-on: [ push, pull_request ]
+on: [push, pull_request]
 
 env:
   CI: true
 
 jobs:
-
   lint:
     uses: haraka/.github/.github/workflows/lint.yml@master
 
@@ -15,31 +14,31 @@ jobs:
   #   secrets: inherit
 
   test:
-    needs: [ lint, get-lts ]
+    needs: [lint, get-lts]
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ ubuntu-latest ]
+        os: [ubuntu-latest]
         node-version: ${{ fromJson(needs.get-lts.outputs.active) }}
       fail-fast: false
     steps:
-    - name: Configure sysctl limits
-      run: |
-         sudo swapoff -a
-         sudo sysctl -w vm.swappiness=1
-         sudo sysctl -w fs.file-max=262144
-         sudo sysctl -w vm.max_map_count=262144
-    - uses: elastic/elastic-github-actions/elasticsearch@master
-      with:
-        stack-version: 8.8.0
-        security-enabled: false
-    - uses: actions/checkout@v3
-    - uses: actions/setup-node@v3
-      name: Node ${{ matrix.node-version }} on ${{ matrix.os }}
-      with:
-        node-version: ${{ matrix.node-version }}
-    - run: npm install
-    - run: npm test
+      - name: Configure sysctl limits
+        run: |
+          sudo swapoff -a
+          sudo sysctl -w vm.swappiness=1
+          sudo sysctl -w fs.file-max=262144
+          sudo sysctl -w vm.max_map_count=262144
+      - uses: elastic/elastic-github-actions/elasticsearch@master
+        with:
+          stack-version: 8.8.0
+          security-enabled: false
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        name: Node ${{ matrix.node-version }} on ${{ matrix.os }}
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm install
+      - run: npm test
 
   get-lts:
     runs-on: ubuntu-latest

diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
@@ -1,10 +1,10 @@
-name: "CodeQL"
+name: 'CodeQL'
 
 on:
   push:
-    branches: [ master ]
+    branches: [master]
   pull_request:
-    branches: [ master ]
+    branches: [master]
   schedule:
     - cron: '18 7 * * 4'
 

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -4,10 +4,11 @@ on:
   push:
     branches:
       - master
+    paths:
+      - package.json
 
 env:
   CI: true
-  node-version: 16
 
 jobs:
   build:
@@ -20,53 +21,49 @@ jobs:
     steps:
       - name: Configure sysctl limits
         run: |
-           sudo swapoff -a
-           sudo sysctl -w vm.swappiness=1
-           sudo sysctl -w fs.file-max=262144
-           sudo sysctl -w vm.max_map_count=262144
+          sudo swapoff -a
+          sudo sysctl -w vm.swappiness=1
+          sudo sysctl -w fs.file-max=262144
+          sudo sysctl -w vm.max_map_count=262144
       - uses: miyataka/elasticsearch-github-actions@1
         with:
           stack-version: '7.6.2'
       - uses: actions/setup-node@v3
-        with:
-          node-version: ${{ env.node-version }}
       - uses: actions/checkout@v3
       - run: npm install
       - run: npm test
 
   publish-npm:
-    needs: [ build ]
+    needs: [build]
     runs-on: ubuntu-latest
     environment: npm
     steps:
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
-          node-version: ${{ env.node-version }}
           registry-url: https://registry.npmjs.org/
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
-          fetch-depth: 0    #  needed by GitHub Release
+          fetch-depth: 0 #  needed by GitHub Release
       - name: publish to NPM
         run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
 
   publish-gpr:
-    needs: [ build ]
+    needs: [build]
     runs-on: ubuntu-latest
     environment: ghpm
     permissions:
       contents: read
       packages: write
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: true
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
-          node-version: ${{ env.node-version }}
           registry-url: https://npm.pkg.github.com/
-          scope: "@haraka"
+          scope: '@haraka'
       - name: rename package with @haraka scope
         run: node .release/npm/prepend-scope.cjs @haraka
       - run: npm publish

diff --git a/.npmignore b/.npmignore
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,2 @@
+singleQuote: true
+semi: false
diff --git a/.release b/.release
diff --git a/Changes.md → CHANGELOG.md b/Changes.md → CHANGELOG.md
@@ -1,81 +1,83 @@
+# Changelog
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/).
+
 ### Unreleased
 
+### [8.0.3] - 2024-08-23
+
+- Create index-template-map_es8.json for ES 8 (#54)
+- move index templates into directory
+- chore: prettier automated code formatting
+- dep: eslint-plugin-haraka -> @haraka/eslint-config
+- update 'lint' script in package.json
+- populate [files] in package.json. Delete .npmignore.
+- ci: only publish when package.json modified
+- doc(CONTRIBUTORS): added
 
 ### [8.0.2] - 2023-12-03
 
 - Update auth example for ES 8.x (#51)
 - Update tls connection options for ES 8 (#49)
 
-
 ### [8.0.0] - 2023-06-09
 
 - dep(elastic): bump dep version to 8.8
 - update @elastic syntax to promise API
 
-
 ### [7.0.0] - 2023-06-08
 
 - chore: update ci & packaging
 - dep(elastic): bump dep version to 7.17
 - bump major version to match ES major version
 
-
 ### [1.1.0] - 2023-06-08
 
 - dep(elastic): dump dep version to 8.8
 
-
 ### [1.0.8] - 2022-06-06
 
 - ci: add .npmignore
 - ci: publish needs es started up too
 
-
 ### [1.0.7] - 2022-06-06
 
 - ci: use shared GHA workflows
 - ci: add submodule .release
 - es7: update index map template
 
-
 ### 1.0.6 - 2020-07-21
 
 - add URI for connection settings
 - add options to specify user & ssl connection settings
 - bump elasticsearch client to version 7.8
 
-
 ### 1.0.5 - 2020-04-29
 
 - update to upstream @elastic/elasticsearch@6
 - convert test runner to mocha
 - use GitHub actions instead of Travis & AppVeyor
 - package.json: depend on latest eslint
 
-
 ### 1.0.4 - 2019-09-22
 
 - update index template for ES 6
 
-
 ### 1.0.3 - 2017-08-22
 
 - fix txr variable scope
 - add tests for get_es_hosts
 
-
 ### 1.0.2 - 2017-07-29
 
 - also prune null values because typeof null === object
 - add test storing doc against index template
 - get ES testing working on AppVeyor (windows)
 
-
 ### 1.0.1 - 2017-07-29
 
 - qualify the path to plugin.\*.msg to avoid collision
 
-
 ### 1.0.0 - 2017-07-14
 
 - initial release
@@ -86,3 +88,5 @@
 [7.0.0]: https://github.com/haraka/haraka-plugin-elasticsearch/releases/tag/7.0.0
 [8.0.0]: https://github.com/haraka/haraka-plugin-elasticsearch/releases/tag/8.0.0
 [8.0.2]: https://github.com/haraka/haraka-plugin-elasticsearch/releases/tag/8.0.2
+[8.0.3]: https://github.com/haraka/haraka-plugin-elasticsearch/releases/tag/v8.0.3
+[1.0.6]: https://github.com/haraka/haraka-plugin-elasticsearch/releases/tag/1.0.6
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
@@ -0,0 +1,8 @@
+# Contributors
+
+This handcrafted artisinal software is brought to you by:
+
+| <img height="80" src="https://avatars.githubusercontent.com/u/261635?v=4"><br><a href="https://github.com/msimerson">msimerson</a> (<a href="https://github.com/haraka/haraka-plugin-elasticsearch/commits?author=msimerson">74</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/1674289?v=4"><br><a href="https://github.com/Dexus">Dexus</a> (<a href="https://github.com/haraka/haraka-plugin-elasticsearch/commits?author=Dexus">2</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/5239282?v=4"><br><a href="https://github.com/sriccio">sriccio</a> (<a href="https://github.com/haraka/haraka-plugin-elasticsearch/commits?author=sriccio">2</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/15035337?v=4"><br><a href="https://github.com/gtech99">gtech99</a> (<a href="https://github.com/haraka/haraka-plugin-elasticsearch/commits?author=gtech99">1</a>)|
+| :---: | :---: | :---: | :---: |
+
+<sub>this file is maintained by [.release](https://github.com/msimerson/.release)</sub>
+2 −0		.prettierrc.yaml
+1 −0		.shellcheckrc
+32 −5		CHANGELOG.md
+1 −1		LICENSE
+26 −16		README.md
+38 −1		base.sh
+82 −0		contributors.js
+14 −3		finish.sh
+7 −6		npm/prepend-scope.cjs
+146 −32		start.sh
+46 −6		submit.sh