Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'lib/tasks/gitlab/docs/compile_deprecations.rake')
-rw-r--r--lib/tasks/gitlab/docs/compile_deprecations.rake39
1 files changed, 31 insertions, 8 deletions
diff --git a/lib/tasks/gitlab/docs/compile_deprecations.rake b/lib/tasks/gitlab/docs/compile_deprecations.rake
index dc9788cb0b2..4ac68a9f850 100644
--- a/lib/tasks/gitlab/docs/compile_deprecations.rake
+++ b/lib/tasks/gitlab/docs/compile_deprecations.rake
@@ -4,19 +4,19 @@ 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}"
+ 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}"
end
desc "Check that the deprecation doc is up to date"
task :check_deprecations do
- require_relative '../../../../tooling/deprecations/docs'
+ require_relative '../../../../tooling/docs/deprecation_handling'
+ path = Rails.root.join("doc/update/deprecations.md")
- contents = Deprecations::Docs.render
- doc = File.read(Deprecations::Docs.path)
+ contents = Docs::DeprecationHandling.new('deprecation').render
+ doc = File.read(path)
if doc == contents
puts "Deprecations doc is up to date."
@@ -25,5 +25,28 @@ namespace :gitlab do
abort
end
end
+
+ desc "Generate removal list from individual files"
+ task :compile_removals 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}"
+ end
+
+ desc "Check that the removal doc is up to date"
+ task :check_removals do
+ require_relative '../../../../tooling/docs/deprecation_handling'
+ path = Rails.root.join("doc/update/removals.md")
+ contents = Docs::DeprecationHandling.new('removal').render
+ doc = File.read(path)
+
+ if doc == contents
+ puts "Removals doc is up to date."
+ else
+ format_output('Removals doc is outdated! You (or your technical writer) can update it by running `bin/rake gitlab:docs:compile_removals`.')
+ abort
+ end
+ end
end
end