diff options
| author | CoprDistGit <infra@openeuler.org> | 2023-05-05 05:33:25 +0000 |
|---|---|---|
| committer | CoprDistGit <infra@openeuler.org> | 2023-05-05 05:33:25 +0000 |
| commit | b4fb4a42727ce992d3ade4b9c6e6e38ee3c1c63a (patch) | |
| tree | 33cec189d2e3a6f4060fe40c09c76ec7ebf9e0e4 | |
| parent | 112fb25c2cae4fdc943e6625e4e1264cdcf2c13d (diff) | |
automatic import of python-flake8-jira-todo-checkeropeneuler20.03
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | python-flake8-jira-todo-checker.spec | 317 | ||||
| -rw-r--r-- | sources | 1 |
3 files changed, 319 insertions, 0 deletions
@@ -0,0 +1 @@ +/flake8-jira-todo-checker-0.6.1.tar.gz diff --git a/python-flake8-jira-todo-checker.spec b/python-flake8-jira-todo-checker.spec new file mode 100644 index 0000000..777a23c --- /dev/null +++ b/python-flake8-jira-todo-checker.spec @@ -0,0 +1,317 @@ +%global _empty_manifest_terminate_build 0 +Name: python-flake8-jira-todo-checker +Version: 0.6.1 +Release: 1 +Summary: Flake8 plugin to check that every TODO, FIXME, QQ etc comment has a valid JIRA ID next to it. +License: GPL-3.0-or-later +URL: https://github.com/simonstjg/flake8-jira-todo-checker +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/f6/87/7af48085f5af7c1672dbda61eec3b983140bb22ce8482f5b55de946bfe98/flake8-jira-todo-checker-0.6.1.tar.gz +BuildArch: noarch + +Requires: python3-flake8 +Requires: python3-jira + +%description +[](https://circleci.com/gh/SimonStJG/flake8-jira-todo-checker/tree/main) +[](https://pypi.python.org/pypi/flake8-jira-todo-checker) +[](https://pypi.python.org/pypi/flake8-jira-todo-checker) +[](https://pypi.python.org/pypi/flake8-jira-todo-checker) +[](https://pypi.python.org/pypi/flake8-jira-todo-checker) +Flake8 plugin to check that: + 1. Every `TODO` comment has a JIRA ID next to it. + 2. Every JIRA ID refers to a JIRA issue which is not closed. + 3. All "TODO" comments use the word "TODO" ("FIXME", "QQ", etc are not allowed). +In other words, this is valid as long as the JIRA issue ABC-123 is not closed: +``` +def hacky_function(): + # TODO ABC-123 Stop reticulating splines +``` +However, none of these comments would be valid: +``` +def hacky_function(): + # TODO No JIRA issue is attached here + # TODO ABC-9182 Not valid if this JIRA issue is resolved! + # TODO FIXME You can't use this word to denote a TODO +``` +You can choose to run this project without connectivity to JIRA, in which case it will only check that every TODO has +an issue attached from the correct project. +## Configuration +### jira-project-ids +A list of valid JIRA project IDs can be provided via the flag `--jira-project-ids` or via the key `jira-project-ids` +in a flake8 configuration file, e.g. +``` +jira-project-ids = ABC,DEF +``` +If no project IDs are provided then all TODOs will be rejected. +### todo-synonyms +A list of words which will be treated like TODO can be provided via the flags `--allowed-todo-synonyms` and +`--disallowed-todo-synonyms` or via the key `allowed-todo-synonyms` and `disallowed-todo-synonyms` in a flake8 +configuration file. +`disallowed-todo-synonyms` will raise an error whenever found in the codebase, and `allowed-todo-synonyms` will raise an +error only if it's missing a JIRA card or that JIRA card is invalid. +Defaults to: +``` +allowed-todo-synonyms = TODO +disallowed-todo-synonyms = FIXME,QQ +``` +### jira-server +The URL of the JIRA server, if unset the status of JIRA cards won't be checked. +### disallowed-jira-statuses, disallowed-jira-resolutions, and disallow-all-jira-resolutions +If a TODO is attached to a JIRA issue whose status is in `disallowed-jira-statuses` then an error will be reported, +ditto if the JIRA card has a resolution in `disallowed-jira-resolutions`. If `disallow-all-jira-resolutions` is set to +`True`, then report an error if issue has any resolution. +Defaults to: +``` +disallowed-jira-statuses = Done +disallow-all-jira-resolutions = True +``` +### JIRA Authentication +We support the same authentication methods as the +[jira-python](https://jira.readthedocs.io/examples.html#authentication) library. +For cookie-based username/password authentication, use the following configuration parameters: +1. `jira-cookie-username` +1. `jira-cookie-password` +For HTTP Basic username/password authentication, use the following configuration parameters: +1. `jira-http-basic-username` +1. `jira-http-basic-password` +For JIRA cloud set `jira-http-basic-username` to your email address and `jira-http-basic-password` to your +[API token](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/). +For OAuth authentication, use the following configuration parameters: +1. `jira-oauth-access-token` +1. `jira-oauth-access-token-secret` +1. `jira-oauth-consumer-key` +1. `jira-oauth-key-cert-file` +For kerberos authentication, set the `jira-kerberos` configuration parameter to True. +# Alternatives +This project is heavily inspired by the [Softwire TODO checker](https://github.com/Softwire/todo-checker). +# Licence +GNU General Public License v3 or later (GPLv3+) +# Development Setup +1. Install [pyenv](https://github.com/pyenv/pyenv-installer) +2. Install [poetry](https://python-poetry.org/) +3. `poetry install` +# Releasing +1. `poetry run bump2version minor` +1. `git push && git push --tags` +1. `tox -e pypi` + +%package -n python3-flake8-jira-todo-checker +Summary: Flake8 plugin to check that every TODO, FIXME, QQ etc comment has a valid JIRA ID next to it. +Provides: python-flake8-jira-todo-checker +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-flake8-jira-todo-checker +[](https://circleci.com/gh/SimonStJG/flake8-jira-todo-checker/tree/main) +[](https://pypi.python.org/pypi/flake8-jira-todo-checker) +[](https://pypi.python.org/pypi/flake8-jira-todo-checker) +[](https://pypi.python.org/pypi/flake8-jira-todo-checker) +[](https://pypi.python.org/pypi/flake8-jira-todo-checker) +Flake8 plugin to check that: + 1. Every `TODO` comment has a JIRA ID next to it. + 2. Every JIRA ID refers to a JIRA issue which is not closed. + 3. All "TODO" comments use the word "TODO" ("FIXME", "QQ", etc are not allowed). +In other words, this is valid as long as the JIRA issue ABC-123 is not closed: +``` +def hacky_function(): + # TODO ABC-123 Stop reticulating splines +``` +However, none of these comments would be valid: +``` +def hacky_function(): + # TODO No JIRA issue is attached here + # TODO ABC-9182 Not valid if this JIRA issue is resolved! + # TODO FIXME You can't use this word to denote a TODO +``` +You can choose to run this project without connectivity to JIRA, in which case it will only check that every TODO has +an issue attached from the correct project. +## Configuration +### jira-project-ids +A list of valid JIRA project IDs can be provided via the flag `--jira-project-ids` or via the key `jira-project-ids` +in a flake8 configuration file, e.g. +``` +jira-project-ids = ABC,DEF +``` +If no project IDs are provided then all TODOs will be rejected. +### todo-synonyms +A list of words which will be treated like TODO can be provided via the flags `--allowed-todo-synonyms` and +`--disallowed-todo-synonyms` or via the key `allowed-todo-synonyms` and `disallowed-todo-synonyms` in a flake8 +configuration file. +`disallowed-todo-synonyms` will raise an error whenever found in the codebase, and `allowed-todo-synonyms` will raise an +error only if it's missing a JIRA card or that JIRA card is invalid. +Defaults to: +``` +allowed-todo-synonyms = TODO +disallowed-todo-synonyms = FIXME,QQ +``` +### jira-server +The URL of the JIRA server, if unset the status of JIRA cards won't be checked. +### disallowed-jira-statuses, disallowed-jira-resolutions, and disallow-all-jira-resolutions +If a TODO is attached to a JIRA issue whose status is in `disallowed-jira-statuses` then an error will be reported, +ditto if the JIRA card has a resolution in `disallowed-jira-resolutions`. If `disallow-all-jira-resolutions` is set to +`True`, then report an error if issue has any resolution. +Defaults to: +``` +disallowed-jira-statuses = Done +disallow-all-jira-resolutions = True +``` +### JIRA Authentication +We support the same authentication methods as the +[jira-python](https://jira.readthedocs.io/examples.html#authentication) library. +For cookie-based username/password authentication, use the following configuration parameters: +1. `jira-cookie-username` +1. `jira-cookie-password` +For HTTP Basic username/password authentication, use the following configuration parameters: +1. `jira-http-basic-username` +1. `jira-http-basic-password` +For JIRA cloud set `jira-http-basic-username` to your email address and `jira-http-basic-password` to your +[API token](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/). +For OAuth authentication, use the following configuration parameters: +1. `jira-oauth-access-token` +1. `jira-oauth-access-token-secret` +1. `jira-oauth-consumer-key` +1. `jira-oauth-key-cert-file` +For kerberos authentication, set the `jira-kerberos` configuration parameter to True. +# Alternatives +This project is heavily inspired by the [Softwire TODO checker](https://github.com/Softwire/todo-checker). +# Licence +GNU General Public License v3 or later (GPLv3+) +# Development Setup +1. Install [pyenv](https://github.com/pyenv/pyenv-installer) +2. Install [poetry](https://python-poetry.org/) +3. `poetry install` +# Releasing +1. `poetry run bump2version minor` +1. `git push && git push --tags` +1. `tox -e pypi` + +%package help +Summary: Development documents and examples for flake8-jira-todo-checker +Provides: python3-flake8-jira-todo-checker-doc +%description help +[](https://circleci.com/gh/SimonStJG/flake8-jira-todo-checker/tree/main) +[](https://pypi.python.org/pypi/flake8-jira-todo-checker) +[](https://pypi.python.org/pypi/flake8-jira-todo-checker) +[](https://pypi.python.org/pypi/flake8-jira-todo-checker) +[](https://pypi.python.org/pypi/flake8-jira-todo-checker) +Flake8 plugin to check that: + 1. Every `TODO` comment has a JIRA ID next to it. + 2. Every JIRA ID refers to a JIRA issue which is not closed. + 3. All "TODO" comments use the word "TODO" ("FIXME", "QQ", etc are not allowed). +In other words, this is valid as long as the JIRA issue ABC-123 is not closed: +``` +def hacky_function(): + # TODO ABC-123 Stop reticulating splines +``` +However, none of these comments would be valid: +``` +def hacky_function(): + # TODO No JIRA issue is attached here + # TODO ABC-9182 Not valid if this JIRA issue is resolved! + # TODO FIXME You can't use this word to denote a TODO +``` +You can choose to run this project without connectivity to JIRA, in which case it will only check that every TODO has +an issue attached from the correct project. +## Configuration +### jira-project-ids +A list of valid JIRA project IDs can be provided via the flag `--jira-project-ids` or via the key `jira-project-ids` +in a flake8 configuration file, e.g. +``` +jira-project-ids = ABC,DEF +``` +If no project IDs are provided then all TODOs will be rejected. +### todo-synonyms +A list of words which will be treated like TODO can be provided via the flags `--allowed-todo-synonyms` and +`--disallowed-todo-synonyms` or via the key `allowed-todo-synonyms` and `disallowed-todo-synonyms` in a flake8 +configuration file. +`disallowed-todo-synonyms` will raise an error whenever found in the codebase, and `allowed-todo-synonyms` will raise an +error only if it's missing a JIRA card or that JIRA card is invalid. +Defaults to: +``` +allowed-todo-synonyms = TODO +disallowed-todo-synonyms = FIXME,QQ +``` +### jira-server +The URL of the JIRA server, if unset the status of JIRA cards won't be checked. +### disallowed-jira-statuses, disallowed-jira-resolutions, and disallow-all-jira-resolutions +If a TODO is attached to a JIRA issue whose status is in `disallowed-jira-statuses` then an error will be reported, +ditto if the JIRA card has a resolution in `disallowed-jira-resolutions`. If `disallow-all-jira-resolutions` is set to +`True`, then report an error if issue has any resolution. +Defaults to: +``` +disallowed-jira-statuses = Done +disallow-all-jira-resolutions = True +``` +### JIRA Authentication +We support the same authentication methods as the +[jira-python](https://jira.readthedocs.io/examples.html#authentication) library. +For cookie-based username/password authentication, use the following configuration parameters: +1. `jira-cookie-username` +1. `jira-cookie-password` +For HTTP Basic username/password authentication, use the following configuration parameters: +1. `jira-http-basic-username` +1. `jira-http-basic-password` +For JIRA cloud set `jira-http-basic-username` to your email address and `jira-http-basic-password` to your +[API token](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/). +For OAuth authentication, use the following configuration parameters: +1. `jira-oauth-access-token` +1. `jira-oauth-access-token-secret` +1. `jira-oauth-consumer-key` +1. `jira-oauth-key-cert-file` +For kerberos authentication, set the `jira-kerberos` configuration parameter to True. +# Alternatives +This project is heavily inspired by the [Softwire TODO checker](https://github.com/Softwire/todo-checker). +# Licence +GNU General Public License v3 or later (GPLv3+) +# Development Setup +1. Install [pyenv](https://github.com/pyenv/pyenv-installer) +2. Install [poetry](https://python-poetry.org/) +3. `poetry install` +# Releasing +1. `poetry run bump2version minor` +1. `git push && git push --tags` +1. `tox -e pypi` + +%prep +%autosetup -n flake8-jira-todo-checker-0.6.1 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-flake8-jira-todo-checker -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Fri May 05 2023 Python_Bot <Python_Bot@openeuler.org> - 0.6.1-1 +- Package Spec generated @@ -0,0 +1 @@ +9098517fa7888d81d8148a87f99ffc07 flake8-jira-todo-checker-0.6.1.tar.gz |