From 2aee09b14d855c07f23f80dfc1c6c61d396a37bb Mon Sep 17 00:00:00 2001 From: Trevor James Smith <10819524+Zeitsperre@users.noreply.github.com> Date: Thu, 25 Jan 2024 17:50:56 -0500 Subject: [PATCH] use sphinx-mdinclude to not duplicate SECURITY.md --- SECURITY.md | 30 ++++++++++++++---------------- docs/conf.py | 4 +++- docs/security.rst | 47 +---------------------------------------------- environment.yml | 1 + pyproject.toml | 1 + 5 files changed, 20 insertions(+), 63 deletions(-) diff --git a/SECURITY.md b/SECURITY.md index 19c730c2d..6f1c898b2 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,7 +1,5 @@ # Security Policy -[//]: # (ATTENTION: This is the Markdown version of docs/security.rst. Any changes should also be made in the ReStructuredText version.) - ## Supported Versions `xclim` is in rapid development and receives regular updates every four to six (4-6) weeks. In the event of a security-related bug discovery soon after the release of an `xclim` version, the last supported version will receive a patch release. @@ -24,17 +22,17 @@ Please follow these steps to report a security vulnerability: You can use the following PGP key to encrypt your communications with us: ------BEGIN PGP PUBLIC KEY BLOCK----- - -mDMEZamQrhYJKwYBBAHaRw8BAQdA+saPvmvr1MYe1nQy3n3QDcRE9T7UzTJ1XH31 -EI4Zb6u0Mk91cmFub3MgR2l0SHViIFN1cHBvcnQgPGdpdGh1Yi1zdXBwb3J0QG91 -cmFub3MuY2E+iJkEExYKAEEWIQSeAu+Cbjupx79jy9VeVFD6o5TVcwUCZamQrgIb -AwUJCWYBgAULCQgHAgIiAgYVCgkICwIEFgIDAQIeBwIXgAAKCRBeVFD6o5TVc4ho -AQDXjDkx0b3A7yl6PQ4hBJ2uYzw0UWbml7mUwVdhMmdZkQD/VJZQNWrCQeOtYEM8 -icZJYwR/OsKFOWqlDytusGGtjwa4OARlqZCuEgorBgEEAZdVAQUBAQdAa41Zabjz -P9O+p6tI69Cnft6U5om3+qCcMo8amTqauH0DAQgHiH4EGBYKACYWIQSeAu+Cbjup -x79jy9VeVFD6o5TVcwUCZamQrgIbDAUJCWYBgAAKCRBeVFD6o5TVcwmaAQClDxW6 -2gir7lhRXAcO+vmRImpGd29TrkcQVh+ak7VlwQEA706d7Kusiorlf/h8pLSoNMmS -kuLGmHpUJ8NVGppU+wo= -=wuxr ------END PGP PUBLIC KEY BLOCK----- + -----BEGIN PGP PUBLIC KEY BLOCK----- + + mDMEZamQrhYJKwYBBAHaRw8BAQdA+saPvmvr1MYe1nQy3n3QDcRE9T7UzTJ1XH31 + EI4Zb6u0Mk91cmFub3MgR2l0SHViIFN1cHBvcnQgPGdpdGh1Yi1zdXBwb3J0QG91 + cmFub3MuY2E+iJkEExYKAEEWIQSeAu+Cbjupx79jy9VeVFD6o5TVcwUCZamQrgIb + AwUJCWYBgAULCQgHAgIiAgYVCgkICwIEFgIDAQIeBwIXgAAKCRBeVFD6o5TVc4ho + AQDXjDkx0b3A7yl6PQ4hBJ2uYzw0UWbml7mUwVdhMmdZkQD/VJZQNWrCQeOtYEM8 + icZJYwR/OsKFOWqlDytusGGtjwa4OARlqZCuEgorBgEEAZdVAQUBAQdAa41Zabjz + P9O+p6tI69Cnft6U5om3+qCcMo8amTqauH0DAQgHiH4EGBYKACYWIQSeAu+Cbjup + x79jy9VeVFD6o5TVcwUCZamQrgIbDAUJCWYBgAAKCRBeVFD6o5TVcwmaAQClDxW6 + 2gir7lhRXAcO+vmRImpGd29TrkcQVh+ak7VlwQEA706d7Kusiorlf/h8pLSoNMmS + kuLGmHpUJ8NVGppU+wo= + =wuxr + -----END PGP PUBLIC KEY BLOCK----- diff --git a/docs/conf.py b/docs/conf.py index 22ef76a68..1ff6daeb0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -103,6 +103,7 @@ "sphinx_autodoc_typehints", "sphinx_codeautolink", "sphinx_copybutton", + "sphinx_mdinclude", "sphinx_rtd_theme", ] @@ -248,7 +249,7 @@ class XCStyle(AlphaStyle): # the built documents. # # The short X.Y version. -version = xclim.__version__ +version = xclim.__version__.split("-")[0] # The full version, including alpha/beta/rc tags. release = xclim.__version__ @@ -267,6 +268,7 @@ class XCStyle(AlphaStyle): "Thumbs.db", ".DS_Store", "notebooks/xclim_training", + "paper/paper.md", "**.ipynb_checkpoints", ] diff --git a/docs/security.rst b/docs/security.rst index e8511e81e..f9a521969 100644 --- a/docs/security.rst +++ b/docs/security.rst @@ -1,46 +1 @@ -=============== -Security Policy -=============== - -.. - This is the ReStructuredText version of SECURITY.md. Any changes should also be made in the Markdown version. - -Supported Versions -================== - -`xclim` is in rapid development and receives regular updates every four to six (4-6) weeks. In the event of a security-related bug discovery soon after the release of an `xclim` version, the last supported version will receive a patch release. - -Reporting a Vulnerability -========================= - -If you believe you have found a security vulnerability in `xclim`, we encourage you to let us know right away. We take all security vulnerabilities seriously and appreciate your efforts to responsibly disclose them. - -Please follow these steps to report a security vulnerability: - -#. **Email**: Email `github-support@ouranos.ca `_ with a detailed description of the vulnerability. If applicable, please include any steps or a proof-of-concept to help us understand and reproduce the issue. - -#. **Encryption (Optional)**: If you are concerned about the sensitivity of the information you are sharing, you can use the PGP key found below to encrypt your communication. - -#. **Response**: We will acknowledge your email within 48 hours and work with you to understand and confirm the vulnerability. - -#. **Fix and Disclosure**: Once the vulnerability is confirmed, we will work to address it promptly. We appreciate your patience as we investigate and implement a fix. Once resolved, we will coordinate the disclosure and provide credit to the reporter unless they prefer to remain anonymous. - -PGP Encryption Key -================== - -You can use the following PGP key to encrypt your communications with us:: - - -----BEGIN PGP PUBLIC KEY BLOCK----- - - mDMEZamQrhYJKwYBBAHaRw8BAQdA+saPvmvr1MYe1nQy3n3QDcRE9T7UzTJ1XH31 - EI4Zb6u0Mk91cmFub3MgR2l0SHViIFN1cHBvcnQgPGdpdGh1Yi1zdXBwb3J0QG91 - cmFub3MuY2E+iJkEExYKAEEWIQSeAu+Cbjupx79jy9VeVFD6o5TVcwUCZamQrgIb - AwUJCWYBgAULCQgHAgIiAgYVCgkICwIEFgIDAQIeBwIXgAAKCRBeVFD6o5TVc4ho - AQDXjDkx0b3A7yl6PQ4hBJ2uYzw0UWbml7mUwVdhMmdZkQD/VJZQNWrCQeOtYEM8 - icZJYwR/OsKFOWqlDytusGGtjwa4OARlqZCuEgorBgEEAZdVAQUBAQdAa41Zabjz - P9O+p6tI69Cnft6U5om3+qCcMo8amTqauH0DAQgHiH4EGBYKACYWIQSeAu+Cbjup - x79jy9VeVFD6o5TVcwUCZamQrgIbDAUJCWYBgAAKCRBeVFD6o5TVcwmaAQClDxW6 - 2gir7lhRXAcO+vmRImpGd29TrkcQVh+ak7VlwQEA706d7Kusiorlf/h8pLSoNMmS - kuLGmHpUJ8NVGppU+wo= - =wuxr - -----END PGP PUBLIC KEY BLOCK----- +.. mdinclude:: ../SECURITY.md diff --git a/environment.yml b/environment.yml index 48f96f614..7eb4742d7 100644 --- a/environment.yml +++ b/environment.yml @@ -65,6 +65,7 @@ dependencies: - sphinx-autodoc-typehints - sphinx-codeautolink - sphinx-copybutton + - sphinx-mdinclude - sphinx-rtd-theme >=1.0 - sphinxcontrib-bibtex - tokenize-rt diff --git a/pyproject.toml b/pyproject.toml index fe5c6958e..d19cab425 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -98,6 +98,7 @@ dev = [ "sphinx-autodoc-typehints", "sphinx-codeautolink", "sphinx-copybutton", + "sphinx-mdinclude", "sphinx-rtd-theme >=1.0", "sphinxcontrib-bibtex", "sphinxcontrib-svg2pdfconverter[Cairosvg]"