lib/tasks/gitlab/docs/compile_deprecations.rake


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

# frozen_string_literal: true

namespace :gitlab do
  namespace :docs do
    desc "Generate deprecation list from individual files"
    task :compile_deprecations do
      require_relative '../../../../tooling/deprecations/docs'

      File.write(Deprecations::Docs.path, Deprecations::Docs.render)

      puts "Deprecations compiled to #{Deprecations::Docs.path}"
    end

    desc "Check that the deprecation doc is up to date"
    task :check_deprecations do
      require_relative '../../../../tooling/deprecations/docs'

      contents = Deprecations::Docs.render
      doc = File.read(Deprecations::Docs.path)

      if doc == contents
        puts "Deprecations doc is up to date."
      else
        format_output('Deprecations doc is outdated! You (or your technical writer) can update it by running `bin/rake gitlab:docs:compile_deprecations`.')
        abort
      end
    end
  end
end