From 4927d4df1fafcc823796b69839d0fb15aaa0c76b Mon Sep 17 00:00:00 2001 From: Matthew Treinish Date: Tue, 1 Sep 2020 16:56:04 -0400 Subject: [PATCH] Explicity set encoding of release notes via reno config The recent reno release 3.2.0 included a new feature [1] for setting the character encoding that reno uses for all it's files. [2] This commit sets this option in the reno config file to make the release note files explicitly utf8. This is important (especially for windows users) because we have literal inlines of the text drawer in some release notes which use utf8 characters. This should avoid issues for users who's system encoding is not compatible with the text drawer output in the release notes. [1] https://opendev.org/openstack/reno/commit/984bcba17e4e0b46763f42015d09680e5c5d5a04 [2] https://docs.openstack.org/reno/latest/user/usage.html#configuring-reno --- releasenotes/config.yaml | 2 ++ requirements-dev.txt | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) create mode 100644 releasenotes/config.yaml diff --git a/releasenotes/config.yaml b/releasenotes/config.yaml new file mode 100644 index 000000000000..fa9f8f379e34 --- /dev/null +++ b/releasenotes/config.yaml @@ -0,0 +1,2 @@ +--- +encoding: utf8 diff --git a/requirements-dev.txt b/requirements-dev.txt index 13be85ed5928..729f2747d76f 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -15,7 +15,7 @@ cython>=0.27.1 pylatexenc>=1.4 ddt>=1.2.0,!=1.4.0 seaborn>=0.9.0 -reno>=3.1.0 +reno>=3.2.0 Sphinx>=1.8.3,<3.1.0 sphinx-rtd-theme>=0.4.0 sphinx-tabs>=1.1.11