Merge branch '6659-deprecate-html-to-pdf-config' into develop

mysociety · Nov 12, 2021 · 72fee22 · 72fee22
2 parents f2e5123 + dfa4793
commit 72fee22
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/doc/CHANGES.md b/doc/CHANGES.md
@@ -56,6 +56,11 @@
 * Support for Ubuntu Bionic (18.04 LTS) will be removed in or after the next
   release.
 * Support for Debian 9 Stretch will be removed in or after the next release.
+* We will remove the `HTML_TO_PDF_COMMAND` configuration variable in the next
+  release. If you aren't already using `wkhtmltopdf` please switch and ensure
+  the path to this command is include in the `UTILITY_SEARCH_PATH` configuration
+  variable. For release 0.40 we only support the wkhtmltopdf v0.11. Support for
+  the latest v0.12 version will be added in the next release.
 * You might see `git protocol on port 9418 is no longer supported` when
   deploying. Please switch to `https` for any theme repo URLs in your
   `config/general.yml` See: https://github.com/mysociety/alaveteli/pull/6630

diff --git a/lib/configuration.rb b/lib/configuration.rb
@@ -136,6 +136,15 @@ module AlaveteliConfiguration
     # rubocop:enable Layout/LineLength
   end
 
+  def self.html_to_pdf_command
+    warn <<~DEPRECATION.squish
+      [DEPRECATION] AlaveteliConfiguration.html_to_pdf_command will be removed
+      in 0.41. Please add the directory containing the wkhtmltopdf command to
+      AlaveteliConfiguration.utility_search_path
+    DEPRECATION
+    super
+  end
+
   def self.method_missing(name)
     key = name.to_s.upcase
     if DEFAULTS.has_key?(key.to_sym)