diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index dcda98c..11934ad 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -12,4 +12,4 @@ Contributors guide: https://github.com/Fdawgs/fastify-floc-off/blob/master/CONTR - [ ] Run `npm test` - [ ] Documentation has been updated and adheres to the style described in [CONTRIBUTING.md](https://github.com/Fdawgs/fastify-floc-off/blob/master/CONTRIBUTING.md#documentation-style) -- [ ] Commit message adheres to the [Conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) style, following the `@commitlint/config-conventional` config +- [ ] Commit message adheres to the [Conventional commits](https://conventionalcommits.org/en/v1.0.0/) style, following the `@commitlint/config-conventional` config diff --git a/CHANGELOG.md b/CHANGELOG.md index 811edee..3536ed8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -194,124 +194,124 @@ * **deps:** bump GoogleCloudPlatform/release-please-action ([7c62c19](https://github.com/Fdawgs/fastify-floc-off/commit/7c62c19c8c0c921c5052d1cc2fd2b67bf4779967)) * **deps:** bump GoogleCloudPlatform/release-please-action from 2 to 3 ([d917de8](https://github.com/Fdawgs/fastify-floc-off/commit/d917de89a90549c546170ad62f04ca6bedf20329)) -### [1.0.3](https://www.github.com/Fdawgs/fastify-floc-off/compare/v1.0.2...v1.0.3) (2021-10-29) +### [1.0.3](https://github.com/Fdawgs/fastify-floc-off/compare/v1.0.2...v1.0.3) (2021-10-29) ### Continuous Integration -* **automerge:** update location of octokit rest methods ([0e82ead](https://www.github.com/Fdawgs/fastify-floc-off/commit/0e82ead92e0dd6f2f87e2ab545a4cd099fc14516)) -* **ci:** revert to workflow-run-clean-action from github concurrency ([2aa77ca](https://www.github.com/Fdawgs/fastify-floc-off/commit/2aa77ca05c4752b0010f77beb3a895aec5608d1e)) +* **automerge:** update location of octokit rest methods ([0e82ead](https://github.com/Fdawgs/fastify-floc-off/commit/0e82ead92e0dd6f2f87e2ab545a4cd099fc14516)) +* **ci:** revert to workflow-run-clean-action from github concurrency ([2aa77ca](https://github.com/Fdawgs/fastify-floc-off/commit/2aa77ca05c4752b0010f77beb3a895aec5608d1e)) ### Miscellaneous -* **.eslintrc:** remove inaccurate sourcetype ([#50](https://www.github.com/Fdawgs/fastify-floc-off/issues/50)) ([d8ed606](https://www.github.com/Fdawgs/fastify-floc-off/commit/d8ed606d41e4a777e53e2695ccb25baeeb839c5e)) -* **.eslintrc:** remove redundant `impliedStrict` option ([#52](https://www.github.com/Fdawgs/fastify-floc-off/issues/52)) ([944ed87](https://www.github.com/Fdawgs/fastify-floc-off/commit/944ed875b4417fe04442e826f6c87c33d139da3c)) -* **.eslintrc:** set correct ecmascript version ([#39](https://www.github.com/Fdawgs/fastify-floc-off/issues/39)) ([bd46255](https://www.github.com/Fdawgs/fastify-floc-off/commit/bd46255f351285051881ac60183992bf512e6208)) -* **.husky/.gitignore:** remove now redundant file ([38199a8](https://www.github.com/Fdawgs/fastify-floc-off/commit/38199a8f107d94f40b895dfe5f7cf6e14c957695)) -* **.prettierrc:** enable `bracketsameline` option ([336b0ed](https://www.github.com/Fdawgs/fastify-floc-off/commit/336b0ed16982548526dd4ae152d7553eddca41f1)) -* **.prettierrc:** override defaults for html, css, and scss files ([#40](https://www.github.com/Fdawgs/fastify-floc-off/issues/40)) ([e9cd573](https://www.github.com/Fdawgs/fastify-floc-off/commit/e9cd57371c640ee7897cbfe29a69911465e0286c)) -* **.vscode:** add `mhutchie.git-graph` extension ([085479a](https://www.github.com/Fdawgs/fastify-floc-off/commit/085479a64a5f15e927b8cf8857094b68c2274cd6)) -* **.vscode:** remove deprecated settings ([#51](https://www.github.com/Fdawgs/fastify-floc-off/issues/51)) ([38d4b67](https://www.github.com/Fdawgs/fastify-floc-off/commit/38d4b673918a4f2fbb6e26af6ed9d09f2e1154d5)) +* **.eslintrc:** remove inaccurate sourcetype ([#50](https://github.com/Fdawgs/fastify-floc-off/issues/50)) ([d8ed606](https://github.com/Fdawgs/fastify-floc-off/commit/d8ed606d41e4a777e53e2695ccb25baeeb839c5e)) +* **.eslintrc:** remove redundant `impliedStrict` option ([#52](https://github.com/Fdawgs/fastify-floc-off/issues/52)) ([944ed87](https://github.com/Fdawgs/fastify-floc-off/commit/944ed875b4417fe04442e826f6c87c33d139da3c)) +* **.eslintrc:** set correct ecmascript version ([#39](https://github.com/Fdawgs/fastify-floc-off/issues/39)) ([bd46255](https://github.com/Fdawgs/fastify-floc-off/commit/bd46255f351285051881ac60183992bf512e6208)) +* **.husky/.gitignore:** remove now redundant file ([38199a8](https://github.com/Fdawgs/fastify-floc-off/commit/38199a8f107d94f40b895dfe5f7cf6e14c957695)) +* **.prettierrc:** enable `bracketsameline` option ([336b0ed](https://github.com/Fdawgs/fastify-floc-off/commit/336b0ed16982548526dd4ae152d7553eddca41f1)) +* **.prettierrc:** override defaults for html, css, and scss files ([#40](https://github.com/Fdawgs/fastify-floc-off/issues/40)) ([e9cd573](https://github.com/Fdawgs/fastify-floc-off/commit/e9cd57371c640ee7897cbfe29a69911465e0286c)) +* **.vscode:** add `mhutchie.git-graph` extension ([085479a](https://github.com/Fdawgs/fastify-floc-off/commit/085479a64a5f15e927b8cf8857094b68c2274cd6)) +* **.vscode:** remove deprecated settings ([#51](https://github.com/Fdawgs/fastify-floc-off/issues/51)) ([38d4b67](https://github.com/Fdawgs/fastify-floc-off/commit/38d4b673918a4f2fbb6e26af6ed9d09f2e1154d5)) ### Documentation -* bump coc from v2.0.0 to v2.1.0 ([#53](https://www.github.com/Fdawgs/fastify-floc-off/issues/53)) ([939cf51](https://www.github.com/Fdawgs/fastify-floc-off/commit/939cf510374fecd1c7bfc69ecba8a0f11799134b)) +* bump coc from v2.0.0 to v2.1.0 ([#53](https://github.com/Fdawgs/fastify-floc-off/issues/53)) ([939cf51](https://github.com/Fdawgs/fastify-floc-off/commit/939cf510374fecd1c7bfc69ecba8a0f11799134b)) ### Dependencies -* **deps-dev:** add eslint-plugin-security-node ([#41](https://www.github.com/Fdawgs/fastify-floc-off/issues/41)) ([00db130](https://www.github.com/Fdawgs/fastify-floc-off/commit/00db13030ab45f727acf35cc34c1ee649752e541)) -* **deps-dev:** bump dev dependencies ([#60](https://www.github.com/Fdawgs/fastify-floc-off/issues/60)) ([e8f3b93](https://www.github.com/Fdawgs/fastify-floc-off/commit/e8f3b93f731e30a09ab8eba09850c56569991135)) -* **deps-dev:** bump eslint-plugin-jest from 24.7.0 to 25.2.2 ([e16c871](https://www.github.com/Fdawgs/fastify-floc-off/commit/e16c87160bec68d10566faef9588f79cdbde3633)) -* **deps-dev:** bump eslint-plugin-jsdoc from 36.1.1 to 37.0.3 ([106412f](https://www.github.com/Fdawgs/fastify-floc-off/commit/106412f8226c816c4428506cacc498467513e505)) -* **deps-dev:** bump prettier from 2.3.2 to 2.4.1 ([b8316d3](https://www.github.com/Fdawgs/fastify-floc-off/commit/b8316d32298ae25131180cdf62b8bf396e0ee425)) -* **deps:** bump actions/checkout from 2.3.4 to 2.3.5 ([42c7bdc](https://www.github.com/Fdawgs/fastify-floc-off/commit/42c7bdcf3df84ede028397165c98cd8db60cd111)) -* **deps:** bump actions/github-script from 4.1 to 5 ([08a9724](https://www.github.com/Fdawgs/fastify-floc-off/commit/08a9724ee02f5ee78ad00343f892ef361377b8ec)) -* **deps:** bump actions/setup-node from 2.4.0 to 2.4.1 ([3ad60a8](https://www.github.com/Fdawgs/fastify-floc-off/commit/3ad60a8c52ab700c65b2fd7289372b5fe8842796)) -* **deps:** bump GoogleCloudPlatform/release-please-action ([99e9e9f](https://www.github.com/Fdawgs/fastify-floc-off/commit/99e9e9f5ef43bd3039f3316759440c5b78284cc2)) -* **deps:** bump GoogleCloudPlatform/release-please-action ([d8bf0d5](https://www.github.com/Fdawgs/fastify-floc-off/commit/d8bf0d535855f7623e50f23be6768f9c2465a220)) -* **deps:** bump wagoid/commitlint-github-action from 4.1.1 to 4.1.4 ([77dd11e](https://www.github.com/Fdawgs/fastify-floc-off/commit/77dd11eaf037b15fac1521fd795cf67f52b7601c)) -* **deps:** bump wagoid/commitlint-github-action from 4.1.4 to 4.1.9 ([7bb7c56](https://www.github.com/Fdawgs/fastify-floc-off/commit/7bb7c5626cc2a2ee92a8f507f362b593402a371c)) +* **deps-dev:** add eslint-plugin-security-node ([#41](https://github.com/Fdawgs/fastify-floc-off/issues/41)) ([00db130](https://github.com/Fdawgs/fastify-floc-off/commit/00db13030ab45f727acf35cc34c1ee649752e541)) +* **deps-dev:** bump dev dependencies ([#60](https://github.com/Fdawgs/fastify-floc-off/issues/60)) ([e8f3b93](https://github.com/Fdawgs/fastify-floc-off/commit/e8f3b93f731e30a09ab8eba09850c56569991135)) +* **deps-dev:** bump eslint-plugin-jest from 24.7.0 to 25.2.2 ([e16c871](https://github.com/Fdawgs/fastify-floc-off/commit/e16c87160bec68d10566faef9588f79cdbde3633)) +* **deps-dev:** bump eslint-plugin-jsdoc from 36.1.1 to 37.0.3 ([106412f](https://github.com/Fdawgs/fastify-floc-off/commit/106412f8226c816c4428506cacc498467513e505)) +* **deps-dev:** bump prettier from 2.3.2 to 2.4.1 ([b8316d3](https://github.com/Fdawgs/fastify-floc-off/commit/b8316d32298ae25131180cdf62b8bf396e0ee425)) +* **deps:** bump actions/checkout from 2.3.4 to 2.3.5 ([42c7bdc](https://github.com/Fdawgs/fastify-floc-off/commit/42c7bdcf3df84ede028397165c98cd8db60cd111)) +* **deps:** bump actions/github-script from 4.1 to 5 ([08a9724](https://github.com/Fdawgs/fastify-floc-off/commit/08a9724ee02f5ee78ad00343f892ef361377b8ec)) +* **deps:** bump actions/setup-node from 2.4.0 to 2.4.1 ([3ad60a8](https://github.com/Fdawgs/fastify-floc-off/commit/3ad60a8c52ab700c65b2fd7289372b5fe8842796)) +* **deps:** bump GoogleCloudPlatform/release-please-action ([99e9e9f](https://github.com/Fdawgs/fastify-floc-off/commit/99e9e9f5ef43bd3039f3316759440c5b78284cc2)) +* **deps:** bump GoogleCloudPlatform/release-please-action ([d8bf0d5](https://github.com/Fdawgs/fastify-floc-off/commit/d8bf0d535855f7623e50f23be6768f9c2465a220)) +* **deps:** bump wagoid/commitlint-github-action from 4.1.1 to 4.1.4 ([77dd11e](https://github.com/Fdawgs/fastify-floc-off/commit/77dd11eaf037b15fac1521fd795cf67f52b7601c)) +* **deps:** bump wagoid/commitlint-github-action from 4.1.4 to 4.1.9 ([7bb7c56](https://github.com/Fdawgs/fastify-floc-off/commit/7bb7c5626cc2a2ee92a8f507f362b593402a371c)) -### [1.0.2](https://www.github.com/Fdawgs/fastify-floc-off/compare/v1.0.1...v1.0.2) (2021-09-06) +### [1.0.2](https://github.com/Fdawgs/fastify-floc-off/compare/v1.0.1...v1.0.2) (2021-09-06) ### Documentation -* **readme:** grammar and wordiness fixes ([bf30cbf](https://www.github.com/Fdawgs/fastify-floc-off/commit/bf30cbf90f94dd5ca340fee9b81bf8cb7fda9092)) -* **readme:** update contributing section ([83df0b3](https://www.github.com/Fdawgs/fastify-floc-off/commit/83df0b3567c6c377f5e0492b8f43c3ab3df41bae)) +* **readme:** grammar and wordiness fixes ([bf30cbf](https://github.com/Fdawgs/fastify-floc-off/commit/bf30cbf90f94dd5ca340fee9b81bf8cb7fda9092)) +* **readme:** update contributing section ([83df0b3](https://github.com/Fdawgs/fastify-floc-off/commit/83df0b3567c6c377f5e0492b8f43c3ab3df41bae)) ### Miscellaneous -* **.github:** use new YAML configured GitHub issue forms ([#35](https://www.github.com/Fdawgs/fastify-floc-off/issues/35)) ([81aa63e](https://www.github.com/Fdawgs/fastify-floc-off/commit/81aa63eb923a07da1e741ad7ae1c7899ea84e663)) -* **ci:** replace `node-version` key with shorter `node` ([#14](https://www.github.com/Fdawgs/fastify-floc-off/issues/14)) ([099340c](https://www.github.com/Fdawgs/fastify-floc-off/commit/099340c5f27ddf573c50a30a987f73a6713bfd72)) -* **vscode:** disable red hat telemetry ([b57bcf7](https://www.github.com/Fdawgs/fastify-floc-off/commit/b57bcf734378e96a8e981f0e753361fff41d50ac)) -* **vscode:** remove user space config setting ([96a4f82](https://www.github.com/Fdawgs/fastify-floc-off/commit/96a4f82706a234f3c1c5d2134b2aa6567a65a702)) -* **workflows:** remove `stale.yml` ([5c66306](https://www.github.com/Fdawgs/fastify-floc-off/commit/5c66306151ce5d6b21ccccfd59f7efae4c073342)) +* **.github:** use new YAML configured GitHub issue forms ([#35](https://github.com/Fdawgs/fastify-floc-off/issues/35)) ([81aa63e](https://github.com/Fdawgs/fastify-floc-off/commit/81aa63eb923a07da1e741ad7ae1c7899ea84e663)) +* **ci:** replace `node-version` key with shorter `node` ([#14](https://github.com/Fdawgs/fastify-floc-off/issues/14)) ([099340c](https://github.com/Fdawgs/fastify-floc-off/commit/099340c5f27ddf573c50a30a987f73a6713bfd72)) +* **vscode:** disable red hat telemetry ([b57bcf7](https://github.com/Fdawgs/fastify-floc-off/commit/b57bcf734378e96a8e981f0e753361fff41d50ac)) +* **vscode:** remove user space config setting ([96a4f82](https://github.com/Fdawgs/fastify-floc-off/commit/96a4f82706a234f3c1c5d2134b2aa6567a65a702)) +* **workflows:** remove `stale.yml` ([5c66306](https://github.com/Fdawgs/fastify-floc-off/commit/5c66306151ce5d6b21ccccfd59f7efae4c073342)) ### Continuous Integration -* **cd:** move perf optimizations and refactoring into same section ([256e987](https://www.github.com/Fdawgs/fastify-floc-off/commit/256e98760fa071f4919bb7458bf2bb6d79bd426b)) -* **ci:** replace workflow-run-cleanup-action with github concurrency ([#36](https://www.github.com/Fdawgs/fastify-floc-off/issues/36)) ([ae97274](https://www.github.com/Fdawgs/fastify-floc-off/commit/ae9727410e4f60bded6ffb2f413fb4fcae22d6fd)) -* fix key usage in `action/setup-node` ([67b257f](https://www.github.com/Fdawgs/fastify-floc-off/commit/67b257f2168e4e83e33084ceaa876733248537fd)) -* **link-check:** reduce frequency from daily to monthly ([#21](https://www.github.com/Fdawgs/fastify-floc-off/issues/21)) ([a544aff](https://www.github.com/Fdawgs/fastify-floc-off/commit/a544aff013f8debaa7d1cbc9d6602ca4accd07f1)) +* **cd:** move perf optimizations and refactoring into same section ([256e987](https://github.com/Fdawgs/fastify-floc-off/commit/256e98760fa071f4919bb7458bf2bb6d79bd426b)) +* **ci:** replace workflow-run-cleanup-action with github concurrency ([#36](https://github.com/Fdawgs/fastify-floc-off/issues/36)) ([ae97274](https://github.com/Fdawgs/fastify-floc-off/commit/ae9727410e4f60bded6ffb2f413fb4fcae22d6fd)) +* fix key usage in `action/setup-node` ([67b257f](https://github.com/Fdawgs/fastify-floc-off/commit/67b257f2168e4e83e33084ceaa876733248537fd)) +* **link-check:** reduce frequency from daily to monthly ([#21](https://github.com/Fdawgs/fastify-floc-off/issues/21)) ([a544aff](https://github.com/Fdawgs/fastify-floc-off/commit/a544aff013f8debaa7d1cbc9d6602ca4accd07f1)) ### Dependencies -* add .npmignore; reduce package size from 12.8kB to 3.9kB ([#37](https://www.github.com/Fdawgs/fastify-floc-off/issues/37)) ([71e4be1](https://www.github.com/Fdawgs/fastify-floc-off/commit/71e4be102b26715fe0045c08c87388053dd05762)) -* **deps-dev:** bump @commitlint/cli from 12.1.4 to 13.1.0 ([5ffa2ef](https://www.github.com/Fdawgs/fastify-floc-off/commit/5ffa2ef384875dc48bcb9f0a4a67ee0799e7f005)) -* **deps-dev:** bump @commitlint/config-conventional ([e005c28](https://www.github.com/Fdawgs/fastify-floc-off/commit/e005c28438f05ed125ca75a47bcca55ddb510658)) -* **deps-dev:** bump eslint-plugin-jsdoc from 33.3.0 to 35.1.2 ([afd7e92](https://www.github.com/Fdawgs/fastify-floc-off/commit/afd7e9225a1362a5f1002d2cd1ee71f18a35db95)) -* **deps-dev:** bump eslint-plugin-jsdoc from 35.5.1 to 36.0.6 ([87cb2a5](https://www.github.com/Fdawgs/fastify-floc-off/commit/87cb2a5049169c6f6836395c4340d971546499c5)) -* **deps-dev:** bump husky from 6.0.0 to 7.0.0 ([dcb877b](https://www.github.com/Fdawgs/fastify-floc-off/commit/dcb877bd6cd39c8b95460484e15616e7406e63c2)) -* **deps-dev:** bump jest from 26.6.3 to 27.0.3 ([c97caa5](https://www.github.com/Fdawgs/fastify-floc-off/commit/c97caa5c50cc4d4ce29945fb27ab2746c4f83bbe)) -* **deps-dev:** bump prettier from 2.2.1 to 2.3.0 ([83dad6e](https://www.github.com/Fdawgs/fastify-floc-off/commit/83dad6ea1684f69044689f69b37642a992e3d70d)) -* **deps-dev:** bump prettier from 2.3.0 to 2.3.2 ([a74fe91](https://www.github.com/Fdawgs/fastify-floc-off/commit/a74fe91c803be36a994662c33b5e1095d71c9a27)) -* **deps:** bump actions/github-script from 4.0.2 to 4.1 ([cb4ae30](https://www.github.com/Fdawgs/fastify-floc-off/commit/cb4ae30025209de549875739485bfb150a670bd9)) -* **deps:** bump actions/setup-node from 2.1.5 to 2.2.0 ([b7609e8](https://www.github.com/Fdawgs/fastify-floc-off/commit/b7609e812c585df95b7ce11bad848b371a59b062)) -* **deps:** bump actions/setup-node from 2.2.0 to 2.3.0 ([d25cb30](https://www.github.com/Fdawgs/fastify-floc-off/commit/d25cb30d839a4213f48bcc386f8544d8b9a1385c)) -* **deps:** bump actions/setup-node from 2.3.0 to 2.4.0 ([53b492a](https://www.github.com/Fdawgs/fastify-floc-off/commit/53b492a086fb6074def585b19567d18c1e430feb)) -* **deps:** bump actions/upload-artifact from 2.2.3 to 2.2.4 ([e0937e2](https://www.github.com/Fdawgs/fastify-floc-off/commit/e0937e2d0286ada1bb87e9793e6819d4454dbd53)) -* **deps:** bump coverallsapp/github-action from 1.1.2 to 1.1.3 ([4a2b86a](https://www.github.com/Fdawgs/fastify-floc-off/commit/4a2b86a75838a539d48e8566e4d6366344715e7a)) -* **deps:** bump GoogleCloudPlatform/release-please-action ([d1966e8](https://www.github.com/Fdawgs/fastify-floc-off/commit/d1966e86d5270eb81cb555c7c6510d87dc25f93c)) -* **deps:** bump wagoid/commitlint-github-action from 3.1.1 to 3.1.4 ([e0b9bdb](https://www.github.com/Fdawgs/fastify-floc-off/commit/e0b9bdbc6804cc8752b7661e46916f7d5b919184)) -* **deps:** bump wagoid/commitlint-github-action from 3.1.4 to 4.1.1 ([048d35c](https://www.github.com/Fdawgs/fastify-floc-off/commit/048d35cbc1b7aab0093f573e1090f895188de94c)) - -### [1.0.1](https://www.github.com/Fdawgs/fastify-floc-off/compare/v1.0.0...v1.0.1) (2021-05-06) +* add .npmignore; reduce package size from 12.8kB to 3.9kB ([#37](https://github.com/Fdawgs/fastify-floc-off/issues/37)) ([71e4be1](https://github.com/Fdawgs/fastify-floc-off/commit/71e4be102b26715fe0045c08c87388053dd05762)) +* **deps-dev:** bump @commitlint/cli from 12.1.4 to 13.1.0 ([5ffa2ef](https://github.com/Fdawgs/fastify-floc-off/commit/5ffa2ef384875dc48bcb9f0a4a67ee0799e7f005)) +* **deps-dev:** bump @commitlint/config-conventional ([e005c28](https://github.com/Fdawgs/fastify-floc-off/commit/e005c28438f05ed125ca75a47bcca55ddb510658)) +* **deps-dev:** bump eslint-plugin-jsdoc from 33.3.0 to 35.1.2 ([afd7e92](https://github.com/Fdawgs/fastify-floc-off/commit/afd7e9225a1362a5f1002d2cd1ee71f18a35db95)) +* **deps-dev:** bump eslint-plugin-jsdoc from 35.5.1 to 36.0.6 ([87cb2a5](https://github.com/Fdawgs/fastify-floc-off/commit/87cb2a5049169c6f6836395c4340d971546499c5)) +* **deps-dev:** bump husky from 6.0.0 to 7.0.0 ([dcb877b](https://github.com/Fdawgs/fastify-floc-off/commit/dcb877bd6cd39c8b95460484e15616e7406e63c2)) +* **deps-dev:** bump jest from 26.6.3 to 27.0.3 ([c97caa5](https://github.com/Fdawgs/fastify-floc-off/commit/c97caa5c50cc4d4ce29945fb27ab2746c4f83bbe)) +* **deps-dev:** bump prettier from 2.2.1 to 2.3.0 ([83dad6e](https://github.com/Fdawgs/fastify-floc-off/commit/83dad6ea1684f69044689f69b37642a992e3d70d)) +* **deps-dev:** bump prettier from 2.3.0 to 2.3.2 ([a74fe91](https://github.com/Fdawgs/fastify-floc-off/commit/a74fe91c803be36a994662c33b5e1095d71c9a27)) +* **deps:** bump actions/github-script from 4.0.2 to 4.1 ([cb4ae30](https://github.com/Fdawgs/fastify-floc-off/commit/cb4ae30025209de549875739485bfb150a670bd9)) +* **deps:** bump actions/setup-node from 2.1.5 to 2.2.0 ([b7609e8](https://github.com/Fdawgs/fastify-floc-off/commit/b7609e812c585df95b7ce11bad848b371a59b062)) +* **deps:** bump actions/setup-node from 2.2.0 to 2.3.0 ([d25cb30](https://github.com/Fdawgs/fastify-floc-off/commit/d25cb30d839a4213f48bcc386f8544d8b9a1385c)) +* **deps:** bump actions/setup-node from 2.3.0 to 2.4.0 ([53b492a](https://github.com/Fdawgs/fastify-floc-off/commit/53b492a086fb6074def585b19567d18c1e430feb)) +* **deps:** bump actions/upload-artifact from 2.2.3 to 2.2.4 ([e0937e2](https://github.com/Fdawgs/fastify-floc-off/commit/e0937e2d0286ada1bb87e9793e6819d4454dbd53)) +* **deps:** bump coverallsapp/github-action from 1.1.2 to 1.1.3 ([4a2b86a](https://github.com/Fdawgs/fastify-floc-off/commit/4a2b86a75838a539d48e8566e4d6366344715e7a)) +* **deps:** bump GoogleCloudPlatform/release-please-action ([d1966e8](https://github.com/Fdawgs/fastify-floc-off/commit/d1966e86d5270eb81cb555c7c6510d87dc25f93c)) +* **deps:** bump wagoid/commitlint-github-action from 3.1.1 to 3.1.4 ([e0b9bdb](https://github.com/Fdawgs/fastify-floc-off/commit/e0b9bdbc6804cc8752b7661e46916f7d5b919184)) +* **deps:** bump wagoid/commitlint-github-action from 3.1.4 to 4.1.1 ([048d35c](https://github.com/Fdawgs/fastify-floc-off/commit/048d35cbc1b7aab0093f573e1090f895188de94c)) + +### [1.0.1](https://github.com/Fdawgs/fastify-floc-off/compare/v1.0.0...v1.0.1) (2021-05-06) ### Documentation -* grammar and readability fixes ([912958f](https://www.github.com/Fdawgs/fastify-floc-off/commit/912958ffbc9f0cf38c41ac485b43971e738daa61)) -* **security:** add missing hyphen ([65b2715](https://www.github.com/Fdawgs/fastify-floc-off/commit/65b27155eb9ec92f4ec6795c5c194e14d5c76ebd)) +* grammar and readability fixes ([912958f](https://github.com/Fdawgs/fastify-floc-off/commit/912958ffbc9f0cf38c41ac485b43971e738daa61)) +* **security:** add missing hyphen ([65b2715](https://github.com/Fdawgs/fastify-floc-off/commit/65b27155eb9ec92f4ec6795c5c194e14d5c76ebd)) ### Dependencies -* **deps-dev:** bump eslint-plugin-jsdoc from 32.3.4 to 33.0.0 ([dfafef3](https://www.github.com/Fdawgs/fastify-floc-off/commit/dfafef3f0bec52b87a511c895dbc5a6da1801fd8)) -* **deps:** bump GoogleCloudPlatform/release-please-action ([a8b1884](https://www.github.com/Fdawgs/fastify-floc-off/commit/a8b1884a8137a0a56a1192dfcfd76d61b93dd9b5)) -* **deps:** bump GoogleCloudPlatform/release-please-action ([4ecd92e](https://www.github.com/Fdawgs/fastify-floc-off/commit/4ecd92e54d8602e66cc915d9a5491f93d592efcc)) -* **deps:** bump typoci/spellcheck-action from v1.0.0 to v1.1.0 ([465f6ba](https://www.github.com/Fdawgs/fastify-floc-off/commit/465f6ba6dc2e7b99f10fa10d48e894a8bab7dc90)) -* **deps:** bump wagoid/commitlint-github-action from v3.1.0 to v3.1.1 ([f656012](https://www.github.com/Fdawgs/fastify-floc-off/commit/f656012e4fe6f50becd774080a637732a1128487)) +* **deps-dev:** bump eslint-plugin-jsdoc from 32.3.4 to 33.0.0 ([dfafef3](https://github.com/Fdawgs/fastify-floc-off/commit/dfafef3f0bec52b87a511c895dbc5a6da1801fd8)) +* **deps:** bump GoogleCloudPlatform/release-please-action ([a8b1884](https://github.com/Fdawgs/fastify-floc-off/commit/a8b1884a8137a0a56a1192dfcfd76d61b93dd9b5)) +* **deps:** bump GoogleCloudPlatform/release-please-action ([4ecd92e](https://github.com/Fdawgs/fastify-floc-off/commit/4ecd92e54d8602e66cc915d9a5491f93d592efcc)) +* **deps:** bump typoci/spellcheck-action from v1.0.0 to v1.1.0 ([465f6ba](https://github.com/Fdawgs/fastify-floc-off/commit/465f6ba6dc2e7b99f10fa10d48e894a8bab7dc90)) +* **deps:** bump wagoid/commitlint-github-action from v3.1.0 to v3.1.1 ([f656012](https://github.com/Fdawgs/fastify-floc-off/commit/f656012e4fe6f50becd774080a637732a1128487)) ## 1.0.0 (2021-04-28) ### Miscellaneous -* initial code commit ([1be3232](https://www.github.com/Fdawgs/fastify-floc-off/commit/1be3232ef0ee6de95c68df49ee4d636b79fe93d1)) +* initial code commit ([1be3232](https://github.com/Fdawgs/fastify-floc-off/commit/1be3232ef0ee6de95c68df49ee4d636b79fe93d1)) ### Dependencies -* **deps-dev:** bump eslint-plugin-promise from 4.3.1 to 5.1.0 ([a5e8135](https://www.github.com/Fdawgs/fastify-floc-off/commit/a5e813581cb6e59d83daa8f1a597cf2afed23945)) -* **deps:** bump actions/github-script from v3.1.1 to v4.0.2 ([01fdfe2](https://www.github.com/Fdawgs/fastify-floc-off/commit/01fdfe2ebc3fceecac237633d70b80776d9b4781)) -* **deps:** bump actions/upload-artifact from v2.2.2 to v2.2.3 ([dc05865](https://www.github.com/Fdawgs/fastify-floc-off/commit/dc05865e0098b046e5154feabd95769850c334c9)) -* **deps:** bump GoogleCloudPlatform/release-please-action ([c2d6d63](https://www.github.com/Fdawgs/fastify-floc-off/commit/c2d6d63eba5361d4f38d7317c8015cc179423ffc)) -* **deps:** bump typoci/spellcheck-action from v0.4.0 to v1.0.0 ([a5a3141](https://www.github.com/Fdawgs/fastify-floc-off/commit/a5a31416aadd25196534cd48dac6159a3afef2eb)) -* **deps:** bump wagoid/commitlint-github-action from v3.0.6 to v3.1.0 ([63d9774](https://www.github.com/Fdawgs/fastify-floc-off/commit/63d977416956242073221dd9928f3f761fafe6e9)) +* **deps-dev:** bump eslint-plugin-promise from 4.3.1 to 5.1.0 ([a5e8135](https://github.com/Fdawgs/fastify-floc-off/commit/a5e813581cb6e59d83daa8f1a597cf2afed23945)) +* **deps:** bump actions/github-script from v3.1.1 to v4.0.2 ([01fdfe2](https://github.com/Fdawgs/fastify-floc-off/commit/01fdfe2ebc3fceecac237633d70b80776d9b4781)) +* **deps:** bump actions/upload-artifact from v2.2.2 to v2.2.3 ([dc05865](https://github.com/Fdawgs/fastify-floc-off/commit/dc05865e0098b046e5154feabd95769850c334c9)) +* **deps:** bump GoogleCloudPlatform/release-please-action ([c2d6d63](https://github.com/Fdawgs/fastify-floc-off/commit/c2d6d63eba5361d4f38d7317c8015cc179423ffc)) +* **deps:** bump typoci/spellcheck-action from v0.4.0 to v1.0.0 ([a5a3141](https://github.com/Fdawgs/fastify-floc-off/commit/a5a31416aadd25196534cd48dac6159a3afef2eb)) +* **deps:** bump wagoid/commitlint-github-action from v3.0.6 to v3.1.0 ([63d9774](https://github.com/Fdawgs/fastify-floc-off/commit/63d977416956242073221dd9928f3f761fafe6e9)) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 74839a7..56bf204 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -111,17 +111,17 @@ community. This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at -[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. +[https://contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. 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]. +[https://contributor-covenant.org/faq][faq]. Translations are available at +[https://contributor-covenant.org/translations][translations]. -[homepage]: https://www.contributor-covenant.org -[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[homepage]: https://contributor-covenant.org +[v2.1]: https://contributor-covenant.org/version/2/1/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 +[faq]: https://contributor-covenant.org/faq +[translations]: https://contributor-covenant.org/translations diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cdff8c2..ce84384 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,14 +3,14 @@ Contributions are welcome and any help that can be offered is greatly appreciated. Please take a moment to read the entire contributing guide. -This repository uses the [Feature Branch Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow), +This repository uses the [Feature Branch Workflow](https://atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow), meaning that development should take place in `feat/` branches, with the `master` branch kept in a stable state. When you submit pull requests, please make sure to fork from and submit back to `master`. Other processes and specifications that are in use in this repository are: - [Semantic versioning](https://semver.org/) -- [Conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) following the @commitlint/config-conventional config +- [Conventional commits](https://conventionalcommits.org/en/v1.0.0/) following the @commitlint/config-conventional config - [Prettier](https://prettier.io/) style guide ## Getting Started @@ -31,7 +31,7 @@ After cloning the repository and installing all the dependencies, there are seve Documentation (both in markdown files and inline comments) should be written in **British English** where possible. -Titles and headings should adhere to the [Associated Press (AP)](https://www.apstylebook.com/) style: +Titles and headings should adhere to the [Associated Press (AP)](https://apstylebook.com/) style: - Capitalise words with three or more letters - Capitalise the first and the last word diff --git a/README.md b/README.md index ac6dab9..30b0e5d 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # fastify-floc-off [![GitHub Release](https://img.shields.io/github/release/Fdawgs/fastify-floc-off.svg)](https://github.com/Fdawgs/fastify-floc-off/releases/latest/) -[![npm version](https://img.shields.io/npm/v/fastify-floc-off)](https://www.npmjs.com/package/fastify-floc-off) +[![npm version](https://img.shields.io/npm/v/fastify-floc-off)](https://npmjs.com/package/fastify-floc-off) ![Build Status](https://github.com/Fdawgs/fastify-floc-off/workflows/CI/badge.svg?branch=master) [![Coverage Status](https://coveralls.io/repos/github/Fdawgs/fastify-floc-off/badge.svg?branch=master)](https://coveralls.io/github/Fdawgs/fastify-floc-off?branch=master) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat)](https://github.com/prettier/prettier) @@ -16,27 +16,21 @@ The `fastify-floc-off` plugin sets the following response header and values to o Permissions-Policy: interest-cohort=() ``` -You can read more about the issues surrounding Google's FLoC [on EFF](https://www.eff.org/deeplinks/2021/03/googles-floc-terrible-idea) and [Plausible Analytics](https://plausible.io/blog/google-floc). +You can read more about the issues surrounding Google's FLoC [on EFF](https://eff.org/deeplinks/2021/03/googles-floc-terrible-idea) and [Plausible Analytics](https://plausible.io/blog/google-floc). [Helmet](https://github.com/helmetjs/helmet) (and in turn [fastify-helmet](https://github.com/fastify/fastify-helmet)) does not currently support `Permissions-Policy` response header setting yet, so this plugin was created out of a need for an easy way to disable/opt-out of Google's FLoC network for systems at [Yeovil District Hospital NHS Foundation Trust](https://yeovilhospital.co.uk/). This ensures both patients and staff accessing web applications at the hospital are not subject to Google's unsolicited tracking. ## Installation -Install using [`npm`](https://www.npmjs.com/package/fastify-floc-off): +Install using `npm`: ```bash npm i fastify-floc-off ``` -Or [`yarn`](https://yarnpkg.com/en/package/fastify-floc-off): - -```bash -yarn add fastify-floc-off -``` - For Fastify v3.x support, use `fastify-floc-off@1.0.7`. -fastify-floc-off's test scripts use npm commands. +fastify-floc-off's test scripts use `npm` commands. ## Example Usage