Skip to content

Commit 2984999

Browse files
authored
doc(CONTRIBUTORS): added (#25)
- populate [files] in package.json - dep: eslint-plugin-haraka -> @haraka/eslint-config - lint: remove duplicate / stale rules from .eslintrc - doc: renamed Changes.md -> CHANGELOG.md - prettier - test: increase timeout for DNS results - chore: remove old config compat shim
1 parent 4bf024b commit 2984999

13 files changed

+375
-375
lines changed

.codeclimate.yml

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
engines:
22
eslint:
33
enabled: true
4-
channel: "eslint-8"
4+
channel: 'eslint-8'
55
config:
6-
config: ".eslintrc.yaml"
6+
config: '.eslintrc.yaml'
77

88
ratings:
9-
paths:
10-
- "**.js"
9+
paths:
10+
- '**.js'
1111

1212
checks:
1313
method-complexity:
1414
config:
15-
threshold: 10
15+
threshold: 10

.eslintrc.yaml

+3-17
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,10 @@ env:
22
node: true
33
es6: true
44
mocha: true
5-
es2020: true
6-
7-
plugins:
8-
- haraka
5+
es2022: true
96

107
extends:
11-
- eslint:recommended
12-
- plugin:haraka/recommended
8+
- '@haraka'
139

1410
rules:
15-
indent: [2, 2, {"SwitchCase": 1}]
16-
17-
root: true
18-
19-
globals:
20-
OK: true
21-
CONT: true
22-
DENY: true
23-
DENYSOFT: true
24-
DENYDISCONNECT: true
25-
DENYSOFTDISCONNECT: true
11+
no-unused-vars: 1

.github/workflows/ci.yml

+5-19
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ name: CI
22

33
on:
44
push:
5+
pull_request:
56

67
env:
78
CI: true
@@ -14,23 +15,8 @@ jobs:
1415
# uses: haraka/.github/.github/workflows/coverage.yml@master
1516
# secrets: inherit
1617

17-
test:
18-
needs: lint
19-
runs-on: ${{ matrix.os }}
20-
strategy:
21-
matrix:
22-
os: [ ubuntu-latest, windows-latest ]
23-
node-version: [ 14, 16, 18 ]
24-
fail-fast: false
18+
ubuntu:
19+
uses: haraka/.github/.github/workflows/ubuntu.yml@master
2520

26-
steps:
27-
- uses: actions/checkout@v3
28-
29-
- uses: actions/setup-node@v3
30-
name: Node ${{ matrix.node-version }} on ${{ matrix.os }}
31-
with:
32-
node-version: ${{ matrix.node-version }}
33-
34-
- run: npm install
35-
36-
- run: npm test
21+
windows:
22+
uses: haraka/.github/.github/workflows/windows.yml@master

.github/workflows/codeql.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@ name: CodeQL
22

33
on:
44
push:
5-
branches: [ master ]
5+
branches: [master]
66
pull_request:
77
# The branches below must be a subset of the branches above
8-
branches: [ master ]
8+
branches: [master]
99
schedule:
1010
- cron: '18 7 * * 4'
1111

.github/workflows/publish.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ env:
1313
jobs:
1414
publish:
1515
uses: haraka/.github/.github/workflows/publish.yml@master
16-
secrets: inherit
16+
secrets: inherit

.prettierrc

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
singleQuote: true
2+
semi: false

Changes.md CHANGELOG.md

+19-11
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,35 @@
1+
# Changelog
2+
3+
The format is based on [Keep a Changelog](https://keepachangelog.com/).
4+
15
### Unreleased
26

7+
### [2.0.3] - 2023-12-13
8+
9+
- ci: use shared ci workflows
10+
- confirm maxmind db has loaded before registering hook #23
11+
- populate [files] in package.json
12+
- dep: eslint-plugin-haraka -> @haraka/eslint-config
13+
- lint: remove duplicate / stale rules from .eslintrc
14+
- doc: renamed Changes.md -> CHANGELOG.md
315

416
### 2.0.2 - 2023-02-07
517

618
- fix: catching DNS timeout exception
719

8-
920
### 2.0.1 - 2022-05-27
1021

1122
- fix: when adding headers, assure ASN is string
1223
- fix: when adding header, look in correct location for asn.org
1324
- when create conn note, only assign properties with values
1425

15-
1626
### 2.0.0 - 2022-05-23
1727

1828
- style: replace most callbacks with async/await
1929
- use builtin/promises where available
2030
- asn.ini: switch default dns provider to rspamd
2131
- dep: remove async
2232

23-
2433
### 1.0.9 - 2022-05-22
2534

2635
- ci: add GitHub Actions CI, #17
@@ -30,7 +39,6 @@
3039
- style: more es6/7
3140
- dep(async): bump version to 3.2
3241

33-
3442
### 1.0.8 - 2018-01-22
3543

3644
- parse maxmind ASN w/o Org data
@@ -39,18 +47,15 @@
3947
- added parse_rspamd test
4048
- emit rspamd DNS provider results (when enabled)
4149

42-
4350
### 1.0.7 - 2017-02-06
4451

4552
- updated eslint to use eslint-plugin-haraka
4653
- aggregate results before emitting
4754

48-
4955
### 1.0.6 - 2016-10-20
5056

51-
* when protocols[setting]=false, don't enable that protocol
52-
* ie, do what the config implies
53-
57+
- when protocols[setting]=false, don't enable that protocol
58+
- ie, do what the config implies
5459

5560
### 1.0.5 - 2016-10-08
5661

@@ -62,5 +67,8 @@
6267

6368
### 1.0.0 - 2016-07-21
6469

65-
66-
[2.0.2]: https://github.com/haraka/haraka-plugin-asn/releases/tag/2.0.2
70+
[1.0.9]: https://github.com/haraka/haraka-plugin-asn/releases/tag/v1.0.9
71+
[2.0.0]: https://github.com/haraka/haraka-plugin-asn/releases/tag/v2.0.0
72+
[2.0.1]: https://github.com/haraka/haraka-plugin-asn/releases/tag/2.0.1
73+
[2.0.2]: https://github.com/haraka/haraka-plugin-asn/releases/tag/v2.0.2
74+
[2.0.3]: https://github.com/haraka/haraka-plugin-asn/releases/tag/2.0.3

CONTRIBUTORS.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Contributors
2+
3+
This handcrafted artisinal software is brought to you by:
4+
5+
| <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-asn/commits?author=msimerson">26</a>) | <img height="80" src="https://avatars.githubusercontent.com/u/934254?v=4"><br><a href="https://github.com/analogic">analogic</a> (<a href="https://github.com/haraka/haraka-plugin-asn/commits?author=analogic">1</a>) | <img height="80" src="https://avatars.githubusercontent.com/u/203240?v=4"><br><a href="https://github.com/lnedry">lnedry</a> (<a href="https://github.com/haraka/haraka-plugin-asn/commits?author=lnedry">1</a>) |
6+
| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
7+
8+
<sub>this file is maintained by [.release](https://github.com/msimerson/.release)</sub>

README.md

+4-7
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,18 @@
66

77
look up ASN from local GeoIP databases and/or DNS based providers.
88

9-
109
### DNS providers
1110

12-
* origin.asn.cymru.com
13-
* asn.routeviews.org
14-
* asn.rspamd.com
15-
11+
- origin.asn.cymru.com
12+
- asn.routeviews.org
13+
- asn.rspamd.com
1614

1715
### Databases
1816

19-
* MaxMind ASN database
17+
- MaxMind ASN database
2018

2119
PS: Run something like [maxmind-geolite-mirror](https://www.npmjs.com/package/maxmind-geolite-mirror) weekly to keep your database files up-to-date.
2220

23-
2421
[ci-img]: https://github.com/haraka/haraka-plugin-asn/actions/workflows/ci.yml/badge.svg
2522
[ci-url]: https://github.com/haraka/haraka-plugin-asn/actions/workflows/ci.yml
2623
[clim-img]: https://codeclimate.com/github/haraka/haraka-plugin-asn/badges/gpa.svg

0 commit comments

Comments
 (0)