summaryrefslogtreecommitdiff
path: root/lib/tasks/gitlab/docs/compile_deprecations.rake
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2021-09-20 13:18:24 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2021-09-20 13:18:24 +0000
commit0653e08efd039a5905f3fa4f6e9cef9f5d2f799c (patch)
tree4dcc884cf6d81db44adae4aa99f8ec1233a41f55 /lib/tasks/gitlab/docs/compile_deprecations.rake
parent744144d28e3e7fddc117924fef88de5d9674fe4c (diff)
downloadgitlab-ce-0653e08efd039a5905f3fa4f6e9cef9f5d2f799c.tar.gz
Add latest changes from gitlab-org/gitlab@14-3-stable-eev14.3.0-rc42
Diffstat (limited to 'lib/tasks/gitlab/docs/compile_deprecations.rake')
-rw-r--r--lib/tasks/gitlab/docs/compile_deprecations.rake29
1 files changed, 29 insertions, 0 deletions
diff --git a/lib/tasks/gitlab/docs/compile_deprecations.rake b/lib/tasks/gitlab/docs/compile_deprecations.rake
new file mode 100644
index 00000000000..0fd43775015
--- /dev/null
+++ b/lib/tasks/gitlab/docs/compile_deprecations.rake
@@ -0,0 +1,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! Please update it by running `bundle exec rake gitlab:docs:compile_deprecations`.')
+ abort
+ end
+ end
+ end
+end