Merge branch 'eread/add-docs-deprecations-and-removals-check' into 'master'

Add documentation deprecations and removals checks to lefthook config

See merge request gitlab-org/gitlab!80686

doc/development/contributing/style_guides.md

@@ -51,20 +51,10 @@ This should return a fully qualified path command with no other output.
 
 ### Lefthook configuration
 
-The current Lefthook configuration can be found in [`lefthook.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lefthook.yml).
+Lefthook is configured with a combination of:
 
-Before you push your changes, Lefthook automatically runs the following checks:
-
-- Danger: Runs a subset of checks that `danger-review` runs on your merge requests.
-- ES lint: Run `yarn run lint:eslint` checks (with the [`.eslintrc.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/.eslintrc.yml) configuration) on the modified `*.{js,vue}` files. Tags: `frontend`, `style`.
-- HAML lint: Run `bundle exec haml-lint` checks (with the [`.haml-lint.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/.haml-lint.yml) configuration) on the modified `*.html.haml` files. Tags: `view`, `haml`, `style`.
-- Markdown lint: Run `yarn markdownlint` checks on the modified `*.md` files. Tags: `documentation`, `style`.
-- SCSS lint: Run `yarn lint:stylelint` checks (with the [`.stylelintrc`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/.stylelintrc) configuration) on the modified `*.scss{,.css}` files. Tags: `stylesheet`, `css`, `style`.
-- RuboCop: Run `bundle exec rubocop` checks (with the [`.rubocop.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/.rubocop.yml) configuration) on the modified `*.rb` files. Tags: `backend`, `style`.
-- Vale: Run `vale` checks (with the [`.vale.ini`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/.vale.ini) configuration) on the modified `*.md` files. Tags: `documentation`, `style`.
-- Documentation metadata: Run checks for the absence of [documentation metadata](../documentation/index.md#metadata).
-
-In addition to the default configuration, you can define a [local configuration](https://github.com/Arkweid/lefthook/blob/master/docs/full_guide.md#local-config).
+- Project configuration in [`lefthook.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lefthook.yml).
+- Any [local configuration](https://github.com/Arkweid/lefthook/blob/master/docs/full_guide.md#local-config).
 
 ### Disable Lefthook temporarily
 

lefthook.yml

@@ -54,3 +54,13 @@ pre-push:
       files: git diff --name-only --diff-filter=d $(git merge-base origin/master HEAD)..HEAD
       glob: 'doc/*.md'
       run: scripts/lint-docs-metadata.sh {files}
+    docs-deprecations:
+      tags: documentation
+      files: git diff --name-only --diff-filter=d $(git merge-base origin/master HEAD)..HEAD
+      glob: 'data/deprecations/*.yml'
+      run: echo "Changes to deprecation files detected. Checking deprecations..\n"; bundle exec rake gitlab:docs:check_deprecations
+    docs-removals:
+      tags: documentation
+      files: git diff --name-only --diff-filter=d $(git merge-base origin/master HEAD)..HEAD
+      glob: 'data/removals/**/*.yml'
+      run: echo "Changes to removals files detected. Checking removals..\n"; bundle exec rake gitlab:docs:check_removals

lib/tasks/gitlab/docs/compile_deprecations.rake

@@ -2,15 +2,19 @@
 
 namespace :gitlab do
   namespace :docs do
+    COLOR_CODE_RESET = "\e[0m"
+    COLOR_CODE_RED = "\e[31m"
+    COLOR_CODE_GREEN = "\e[32m"
+
     desc "Generate deprecation list from individual files"
     task :compile_deprecations do
       require_relative '../../../../tooling/docs/deprecation_handling'
       path = Rails.root.join("doc/update/deprecations.md")
       File.write(path, Docs::DeprecationHandling.new('deprecation').render)
-      puts "Deprecations compiled to #{path}"
+      puts "#{COLOR_CODE_GREEN}INFO: Deprecations compiled to #{path}.#{COLOR_CODE_RESET}"
     end
 
-    desc "Check that the deprecation doc is up to date"
+    desc "Check that the deprecation documentation is up to date"
     task :check_deprecations do
       require_relative '../../../../tooling/docs/deprecation_handling'
       path = Rails.root.join("doc/update/deprecations.md")
@@ -19,9 +23,15 @@ namespace :gitlab do
       doc = File.read(path)
 
       if doc == contents
-        puts "Deprecations doc is up to date."
+        puts "#{COLOR_CODE_GREEN}INFO: Deprecations documentation is up to date.#{COLOR_CODE_RESET}"
       else
-        format_output('Deprecations doc is outdated! You (or your technical writer) can update it by running `bin/rake gitlab:docs:compile_deprecations`.')
+        warn <<~EOS
+        #{COLOR_CODE_RED}ERROR: Deprecations documentation is outdated!#{COLOR_CODE_RESET}
+        To update the deprecations documentation, either:
+
+        - Run `bin/rake gitlab:docs:compile_deprecations` and commit the changes to this branch.
+        - Have a technical writer resolve the issue.
+        EOS
         abort
       end
     end
@@ -31,10 +41,10 @@ namespace :gitlab do
       require_relative '../../../../tooling/docs/deprecation_handling'
       path = Rails.root.join("doc/update/removals.md")
       File.write(path, Docs::DeprecationHandling.new('removal').render)
-      puts "Removals compiled to #{path}"
+      puts "#{COLOR_CODE_GREEN}INFO: Removals compiled to #{path}.#{COLOR_CODE_RESET}"
     end
 
-    desc "Check that the removal doc is up to date"
+    desc "Check that the removal documentation is up to date"
     task :check_removals do
       require_relative '../../../../tooling/docs/deprecation_handling'
       path = Rails.root.join("doc/update/removals.md")
@@ -42,9 +52,15 @@ namespace :gitlab do
       doc = File.read(path)
 
       if doc == contents
-        puts "Removals doc is up to date."
+        puts "#{COLOR_CODE_GREEN}INFO: Removals documentation is up to date.#{COLOR_CODE_RESET}"
       else
-        format_output('Removals doc is outdated! You (or your technical writer) can update it by running `bin/rake gitlab:docs:compile_removals`.')
+        warn <<~EOS
+        #{COLOR_CODE_RED}ERROR: Removals documentation is outdated!#{COLOR_CODE_RESET}
+        To update the removals documentation, either:
+
+        - Run `bin/rake gitlab:docs:compile_removals` and commit the changes to this branch.
+        - Have a technical writer resolve the issue.
+        EOS
         abort
       end
     end