From cee9be708f1b19cefc4eea5af2a6a88eb4f9186b Mon Sep 17 00:00:00 2001 From: Brad Zacher Date: Fri, 4 Sep 2020 14:15:38 -0700 Subject: [PATCH] docs: add link to v4 release notes to the changelogs (#2487) Some users use CHANGELOG.md as the source of truth for releases and don't check the github releases page. We should probably delete these files and just have everything in the GH releases page. This adds a link to the v4 releases page and adds a disclaimer to the top of the file pointing at the releases page. --- CHANGELOG.md | 3 +++ package.json | 3 +++ packages/eslint-plugin-internal/CHANGELOG.md | 3 +++ packages/eslint-plugin-tslint/CHANGELOG.md | 4 ++++ packages/eslint-plugin/CHANGELOG.md | 3 +++ packages/experimental-utils/CHANGELOG.md | 3 +++ packages/parser/CHANGELOG.md | 3 +++ packages/scope-manager/CHANGELOG.md | 3 +++ packages/shared-fixtures/CHANGELOG.md | 4 ++++ packages/types/CHANGELOG.md | 3 +++ 10 files changed, 32 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7d25acfc31c..fcc5ce4c7ec 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,8 @@ # Change Log All notable changes to this project will be documented in this file. +This file is just a history of the commits included in each release. +**For full release notes, please see [the github releases page](https://github.com/typescript-eslint/typescript-eslint/releases)** See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. ## [4.0.1](https://github.com/typescript-eslint/typescript-eslint/compare/v4.0.0...v4.0.1) (2020-08-31) @@ -16,6 +18,7 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline # [4.0.0](https://github.com/typescript-eslint/typescript-eslint/compare/v3.10.1...v4.0.0) (2020-08-31) +## [Please see the release notes for v4.0.0](https://github.com/typescript-eslint/typescript-eslint/releases/tag/v4.0.0) ### Bug Fixes diff --git a/package.json b/package.json index 5d02e9b5e43..60668f219cf 100644 --- a/package.json +++ b/package.json @@ -54,6 +54,9 @@ "body-max-length": [ 0 ], + "body-max-line-length": [ + 0 + ], "footer-max-length": [ 0 ], diff --git a/packages/eslint-plugin-internal/CHANGELOG.md b/packages/eslint-plugin-internal/CHANGELOG.md index b2660df9e2b..8c528d2a56e 100644 --- a/packages/eslint-plugin-internal/CHANGELOG.md +++ b/packages/eslint-plugin-internal/CHANGELOG.md @@ -1,6 +1,8 @@ # Change Log All notable changes to this project will be documented in this file. +This file is just a history of the commits included in each release. +**For full release notes, please see [the github releases page](https://github.com/typescript-eslint/typescript-eslint/releases)** See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. ## [4.0.1](https://github.com/typescript-eslint/typescript-eslint/compare/v4.0.0...v4.0.1) (2020-08-31) @@ -13,6 +15,7 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline # [4.0.0](https://github.com/typescript-eslint/typescript-eslint/compare/v3.10.1...v4.0.0) (2020-08-31) +## [Please see the release notes for v4.0.0](https://github.com/typescript-eslint/typescript-eslint/releases/tag/v4.0.0) ### Features diff --git a/packages/eslint-plugin-tslint/CHANGELOG.md b/packages/eslint-plugin-tslint/CHANGELOG.md index 2bd3091d24f..b6bd6b6d1a4 100644 --- a/packages/eslint-plugin-tslint/CHANGELOG.md +++ b/packages/eslint-plugin-tslint/CHANGELOG.md @@ -1,6 +1,8 @@ # Change Log All notable changes to this project will be documented in this file. +This file is just a history of the commits included in each release. +**For full release notes, please see [the github releases page](https://github.com/typescript-eslint/typescript-eslint/releases)** See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. ## [4.0.1](https://github.com/typescript-eslint/typescript-eslint/compare/v4.0.0...v4.0.1) (2020-08-31) @@ -13,6 +15,8 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline # [4.0.0](https://github.com/typescript-eslint/typescript-eslint/compare/v3.10.1...v4.0.0) (2020-08-31) +## [Please see the release notes for v4.0.0](https://github.com/typescript-eslint/typescript-eslint/releases/tag/v4.0.0) + **Note:** Version bump only for package @typescript-eslint/eslint-plugin-tslint diff --git a/packages/eslint-plugin/CHANGELOG.md b/packages/eslint-plugin/CHANGELOG.md index 97588ac1f54..985da3c8304 100644 --- a/packages/eslint-plugin/CHANGELOG.md +++ b/packages/eslint-plugin/CHANGELOG.md @@ -1,6 +1,8 @@ # Change Log All notable changes to this project will be documented in this file. +This file is just a history of the commits included in each release. +**For full release notes, please see [the github releases page](https://github.com/typescript-eslint/typescript-eslint/releases)** See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. ## [4.0.1](https://github.com/typescript-eslint/typescript-eslint/compare/v4.0.0...v4.0.1) (2020-08-31) @@ -16,6 +18,7 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline # [4.0.0](https://github.com/typescript-eslint/typescript-eslint/compare/v3.10.1...v4.0.0) (2020-08-31) +## [Please see the release notes for v4.0.0](https://github.com/typescript-eslint/typescript-eslint/releases/tag/v4.0.0) ### Bug Fixes diff --git a/packages/experimental-utils/CHANGELOG.md b/packages/experimental-utils/CHANGELOG.md index 6e03e9b2a4f..27434ea7eb3 100644 --- a/packages/experimental-utils/CHANGELOG.md +++ b/packages/experimental-utils/CHANGELOG.md @@ -1,6 +1,8 @@ # Change Log All notable changes to this project will be documented in this file. +This file is just a history of the commits included in each release. +**For full release notes, please see [the github releases page](https://github.com/typescript-eslint/typescript-eslint/releases)** See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. ## [4.0.1](https://github.com/typescript-eslint/typescript-eslint/compare/v4.0.0...v4.0.1) (2020-08-31) @@ -13,6 +15,7 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline # [4.0.0](https://github.com/typescript-eslint/typescript-eslint/compare/v3.10.1...v4.0.0) (2020-08-31) +## [Please see the release notes for v4.0.0](https://github.com/typescript-eslint/typescript-eslint/releases/tag/v4.0.0) ### Features diff --git a/packages/parser/CHANGELOG.md b/packages/parser/CHANGELOG.md index e51e27adc38..5ffef953896 100644 --- a/packages/parser/CHANGELOG.md +++ b/packages/parser/CHANGELOG.md @@ -1,6 +1,8 @@ # Change Log All notable changes to this project will be documented in this file. +This file is just a history of the commits included in each release. +**For full release notes, please see [the github releases page](https://github.com/typescript-eslint/typescript-eslint/releases)** See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. ## [4.0.1](https://github.com/typescript-eslint/typescript-eslint/compare/v4.0.0...v4.0.1) (2020-08-31) @@ -13,6 +15,7 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline # [4.0.0](https://github.com/typescript-eslint/typescript-eslint/compare/v3.10.1...v4.0.0) (2020-08-31) +## [Please see the release notes for v4.0.0](https://github.com/typescript-eslint/typescript-eslint/releases/tag/v4.0.0) ### Features diff --git a/packages/scope-manager/CHANGELOG.md b/packages/scope-manager/CHANGELOG.md index c0a53321092..32214ad72f0 100644 --- a/packages/scope-manager/CHANGELOG.md +++ b/packages/scope-manager/CHANGELOG.md @@ -1,6 +1,8 @@ # Change Log All notable changes to this project will be documented in this file. +This file is just a history of the commits included in each release. +**For full release notes, please see [the github releases page](https://github.com/typescript-eslint/typescript-eslint/releases)** See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. ## [4.0.1](https://github.com/typescript-eslint/typescript-eslint/compare/v4.0.0...v4.0.1) (2020-08-31) @@ -13,6 +15,7 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline # [4.0.0](https://github.com/typescript-eslint/typescript-eslint/compare/v3.10.1...v4.0.0) (2020-08-31) +## [Please see the release notes for v4.0.0](https://github.com/typescript-eslint/typescript-eslint/releases/tag/v4.0.0) ### Bug Fixes diff --git a/packages/shared-fixtures/CHANGELOG.md b/packages/shared-fixtures/CHANGELOG.md index 0ece944f40d..78d31dafa61 100644 --- a/packages/shared-fixtures/CHANGELOG.md +++ b/packages/shared-fixtures/CHANGELOG.md @@ -1,6 +1,8 @@ # Change Log All notable changes to this project will be documented in this file. +This file is just a history of the commits included in each release. +**For full release notes, please see [the github releases page](https://github.com/typescript-eslint/typescript-eslint/releases)** See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. ## [4.0.1](https://github.com/typescript-eslint/typescript-eslint/compare/v4.0.0...v4.0.1) (2020-08-31) @@ -13,6 +15,8 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline # [4.0.0](https://github.com/typescript-eslint/typescript-eslint/compare/v3.10.1...v4.0.0) (2020-08-31) +## [Please see the release notes for v4.0.0](https://github.com/typescript-eslint/typescript-eslint/releases/tag/v4.0.0) + **Note:** Version bump only for package @typescript-eslint/shared-fixtures diff --git a/packages/types/CHANGELOG.md b/packages/types/CHANGELOG.md index 3fac794a2f5..31cc40b144d 100644 --- a/packages/types/CHANGELOG.md +++ b/packages/types/CHANGELOG.md @@ -1,6 +1,8 @@ # Change Log All notable changes to this project will be documented in this file. +This file is just a history of the commits included in each release. +**For full release notes, please see [the github releases page](https://github.com/typescript-eslint/typescript-eslint/releases)** See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. ## [4.0.1](https://github.com/typescript-eslint/typescript-eslint/compare/v4.0.0...v4.0.1) (2020-08-31) @@ -13,6 +15,7 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline # [4.0.0](https://github.com/typescript-eslint/typescript-eslint/compare/v3.10.1...v4.0.0) (2020-08-31) +## [Please see the release notes for v4.0.0](https://github.com/typescript-eslint/typescript-eslint/releases/tag/v4.0.0) ### Bug Fixes