From 66734cc67c8527df24da43ee360fc7d1f4865683 Mon Sep 17 00:00:00 2001 From: jce Date: Tue, 21 Feb 2023 15:57:44 +0100 Subject: [PATCH 1/2] Improve documentation for Code Quality feature --- README.rst | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index fe9c367b..b3ff442a 100644 --- a/README.rst +++ b/README.rst @@ -289,8 +289,6 @@ input file. When this setting is missing, the default value ``true`` is used. .. _`Robot Framework`: https://robotframework.org/ .. _`--xunit report.xml`: https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#xunit-compatible-result-file -.. _configuration_file: - ---------------------------------- Configuration File to Pass Options ---------------------------------- @@ -422,9 +420,9 @@ Code Quality Report Use `-C, --code-quality` to let the plugin generate `a Code Quality report`_ for GitLab CI. All counted Sphinx, Doxygen and XMLRunner will be included. Other checker types are not supported by this feature. The report is -a JSON file that implements `a subset of the Code Climate spec`_. Declare this file `as an artifact`_ of the -`code_quality` CI job. -If a warning doesn't contain a path, `"cq_default_path"` from the configuration_file_ will be used. +a JSON file that implements `a subset of the Code Climate spec`_. Define this file `as a codequality report artifact`_ +of the CI job. +If a warning doesn't contain a path, `"cq_default_path"` from the `configuration file to pass options`_ will be used. If not configured, `.gitlab-ci.yml` will be used as a fallback path. ======================= @@ -446,4 +444,4 @@ development of the plugin. We encourage anyone to contribute to our repository. .. _YAML: https://yaml.org/spec/1.2.2/ .. _a Code Quality report: https://docs.gitlab.com/ee/ci/testing/code_quality.html .. _a subset of the Code Climate spec: https://docs.gitlab.com/ee/ci/testing/code_quality.html#implement-a-custom-tool -.. _as an artifact: https://docs.gitlab.com/ee/ci/testing/code_quality.html#download-output-in-json-format +.. _as a codequality report artifact: https://docs.gitlab.com/ee/ci/yaml/artifacts_reports.html#artifactsreportscodequality From 49528124c78162ef73ebd051b58a112e47a506da Mon Sep 17 00:00:00 2001 From: jce Date: Tue, 21 Feb 2023 16:20:01 +0100 Subject: [PATCH 2/2] Add relevant URLs to display on PyPI --- setup.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/setup.py b/setup.py index 3e97201d..40c1a777 100644 --- a/setup.py +++ b/setup.py @@ -23,6 +23,11 @@ 'Useable with plugin-less CI systems.', long_description=open("README.rst").read(), long_description_content_type='text/x-rst', + project_urls={ + 'Documentation': 'https://melexis.github.io/warnings-plugin', + 'Source': 'https://github.com/melexis/warnings-plugin', + 'Tracker': 'https://github.com/melexis/warnings-plugin/issues', + }, zip_safe=False, license='Apache License, Version 2.0', platforms='any',