refactor: deprecate GitHub reporter (#453)

Author: dkrutskikh

CHANGELOG.md

@@ -1,10 +1,14 @@
 # Changelog
 
+## Unreleased
+
+* Deprecated GitHub reporter.
+
 ## 4.3.0-dev.1
 
-* Add support for global rules-exclude
+* Add support for global rules-exclude.
 * Add `Halstead Volume` metric.
-* Add ability to configure anti-pattern severity
+* Add ability to configure anti-pattern severity.
 * Add `--fatal-warnings`, `--fatal-performance`, `--fatal-style` cli arguments.
 
 ## 4.2.1

lib/src/analyzers/lint_analyzer/reporters/reporters_list/github/lint_github_reporter.dart

@@ -4,6 +4,9 @@ import '../../../../../reporters/models/github_reporter.dart';
 import '../../../models/lint_file_report.dart';
 import '../../../models/severity.dart';
 
+const _deprecationMessage =
+    'DEPRECATED! This reporter is deprecated and will be removed in 5.0.0. You can migrate on our GitHub Action.';
+
 class LintGitHubReporter extends GitHubReporter<LintFileReport> {
   const LintGitHubReporter(IOSink output) : super(output);
 
@@ -16,7 +19,7 @@ class LintGitHubReporter extends GitHubReporter<LintFileReport> {
     for (final analysisRecord in records) {
       for (final antiPattern in analysisRecord.antiPatternCases) {
         output.writeln(GitHubReporter.commands.warning(
-          antiPattern.message,
+          '$_deprecationMessage ${antiPattern.message}',
           absolutePath: analysisRecord.path,
           sourceSpan: antiPattern.location,
         ));
@@ -26,12 +29,12 @@ class LintGitHubReporter extends GitHubReporter<LintFileReport> {
         output.writeln(
           issue.severity == Severity.error
               ? GitHubReporter.commands.error(
-                  issue.message,
+                  '$_deprecationMessage ${issue.message}',
                   absolutePath: analysisRecord.path,
                   sourceSpan: issue.location,
                 )
               : GitHubReporter.commands.warning(
-                  issue.message,
+                  '$_deprecationMessage ${issue.message}',
                   absolutePath: analysisRecord.path,
                   sourceSpan: issue.location,
                 ),

test/analyzers/lint_analyzer/reporters/reporters_list/lint_github_reporter_test.dart

@@ -64,7 +64,7 @@ void main() {
       expect(
         verify(() => output.writeln(captureAny())).captured.cast<String>(),
         equals([
-          '::warning file=/home/developer/work/project/example.dart,line=2,col=3::first issue message',
+          '::warning file=/home/developer/work/project/example.dart,line=2,col=3::DEPRECATED! This reporter is deprecated and will be removed in 5.0.0. You can migrate on our GitHub Action. first issue message',
         ]),
       );
     });
@@ -127,8 +127,8 @@ void main() {
       expect(
         verify(() => output.writeln(captureAny())).captured.cast<String>(),
         equals([
-          '::warning file=/home/developer/work/project/example.dart,line=2,col=3::first issue message',
-          '::error file=/home/developer/work/project/example.dart,line=4,col=3::second issue message',
+          '::warning file=/home/developer/work/project/example.dart,line=2,col=3::DEPRECATED! This reporter is deprecated and will be removed in 5.0.0. You can migrate on our GitHub Action. first issue message',
+          '::error file=/home/developer/work/project/example.dart,line=4,col=3::DEPRECATED! This reporter is deprecated and will be removed in 5.0.0. You can migrate on our GitHub Action. second issue message',
         ]),
       );
     });