From e36cddd026a38850deba35a85001b15a343f96e4 Mon Sep 17 00:00:00 2001 From: Eric Brown Date: Sat, 29 Jan 2022 00:10:42 -0800 Subject: [PATCH 1/4] Delete releasenotes directory (more openstack leftovers) The releasenotes directory was another mechanism used for OpenStack to generate a release note in an OpenStack specific way. It hasn't been used in Bandit since we have migrated Bandit from Gerrit to GitHub. Therefore, removing the whole directory of these files. --- .../add-pycrypto-warn-c430f40f1d0fb44a.yaml | 6 - .../add-url-in-json-64f90161ab613a54.yaml | 5 - .../add-url-in-yaml-0bfdcc93f5b6d118.yaml | 5 - .../notes/add_reno-b8585fc3ffe775cb.yaml | 3 - .../notes/target-in-ini-81802418b1cc970f.yaml | 5 - releasenotes/source/_static/.placeholder | 0 releasenotes/source/_templates/.placeholder | 0 releasenotes/source/conf.py | 261 ------------------ releasenotes/source/index.rst | 21 -- releasenotes/source/unreleased.rst | 5 - 10 files changed, 311 deletions(-) delete mode 100644 releasenotes/notes/add-pycrypto-warn-c430f40f1d0fb44a.yaml delete mode 100644 releasenotes/notes/add-url-in-json-64f90161ab613a54.yaml delete mode 100644 releasenotes/notes/add-url-in-yaml-0bfdcc93f5b6d118.yaml delete mode 100644 releasenotes/notes/add_reno-b8585fc3ffe775cb.yaml delete mode 100644 releasenotes/notes/target-in-ini-81802418b1cc970f.yaml delete mode 100644 releasenotes/source/_static/.placeholder delete mode 100644 releasenotes/source/_templates/.placeholder delete mode 100644 releasenotes/source/conf.py delete mode 100644 releasenotes/source/index.rst delete mode 100644 releasenotes/source/unreleased.rst diff --git a/releasenotes/notes/add-pycrypto-warn-c430f40f1d0fb44a.yaml b/releasenotes/notes/add-pycrypto-warn-c430f40f1d0fb44a.yaml deleted file mode 100644 index cc4166cbc..000000000 --- a/releasenotes/notes/add-pycrypto-warn-c430f40f1d0fb44a.yaml +++ /dev/null @@ -1,6 +0,0 @@ ---- -features: - - | - PyCrypto library is no longer actively maintained and should be replaced - with ``cryptography`` library. A new rule is added to detect and warn the - import and use of ``pycrypto`` module. diff --git a/releasenotes/notes/add-url-in-json-64f90161ab613a54.yaml b/releasenotes/notes/add-url-in-json-64f90161ab613a54.yaml deleted file mode 100644 index 7e8261c59..000000000 --- a/releasenotes/notes/add-url-in-json-64f90161ab613a54.yaml +++ /dev/null @@ -1,5 +0,0 @@ ---- -features: - - | - [bug/1695890] The ``more_info`` URL link displayed in the HTML output is - now also available in the JSON output. diff --git a/releasenotes/notes/add-url-in-yaml-0bfdcc93f5b6d118.yaml b/releasenotes/notes/add-url-in-yaml-0bfdcc93f5b6d118.yaml deleted file mode 100644 index e402b9725..000000000 --- a/releasenotes/notes/add-url-in-yaml-0bfdcc93f5b6d118.yaml +++ /dev/null @@ -1,5 +0,0 @@ ---- -features: - - | - [bug/1746827] The ``more_info`` URL link displayed in the HTML and JSON - outputs is now also available in the YAML output. diff --git a/releasenotes/notes/add_reno-b8585fc3ffe775cb.yaml b/releasenotes/notes/add_reno-b8585fc3ffe775cb.yaml deleted file mode 100644 index 54d5cf8b3..000000000 --- a/releasenotes/notes/add_reno-b8585fc3ffe775cb.yaml +++ /dev/null @@ -1,3 +0,0 @@ ---- -other: - - Switch to reno for managing release notes. diff --git a/releasenotes/notes/target-in-ini-81802418b1cc970f.yaml b/releasenotes/notes/target-in-ini-81802418b1cc970f.yaml deleted file mode 100644 index 0fe31257b..000000000 --- a/releasenotes/notes/target-in-ini-81802418b1cc970f.yaml +++ /dev/null @@ -1,5 +0,0 @@ ---- -features: - - | - The 'targets' CLI arguments are now optional and can be specified in the - ini file. diff --git a/releasenotes/source/_static/.placeholder b/releasenotes/source/_static/.placeholder deleted file mode 100644 index e69de29bb..000000000 diff --git a/releasenotes/source/_templates/.placeholder b/releasenotes/source/_templates/.placeholder deleted file mode 100644 index e69de29bb..000000000 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py deleted file mode 100644 index 0e232bb07..000000000 --- a/releasenotes/source/conf.py +++ /dev/null @@ -1,261 +0,0 @@ -# -*- coding: utf-8 -*- -# SPDX-License-Identifier: Apache-2.0 - -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# sys.path.insert(0, os.path.abspath('.')) - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -# needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - 'oslosphinx', - 'reno.sphinxext', -] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The encoding of source files. -# source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = u'Bandit Release Notes' -copyright = u'2016, Bandit Developers' - -# Release notes do not need a version number in the title, they -# cover multiple releases. -# The full version, including alpha/beta/rc tags. -release = '' -# The short X.Y version. -version = '' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -# today = '' -# Else, today_fmt is used as the format for a strftime call. -# today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = [] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -# default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -# add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -# add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -# show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# A list of ignored prefixes for module index sorting. -# modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -# keep_warnings = False - - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = 'default' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -# html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -# html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -# html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -# html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -# html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -# html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -# html_extra_path = [] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -# html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -# html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -# html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -# html_additional_pages = {} - -# If false, no module index is generated. -# html_domain_indices = True - -# If false, no index is generated. -# html_use_index = True - -# If true, the index is split into individual pages for each letter. -# html_split_index = False - -# If true, links to the reST sources are added to the pages. -# html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -# html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -# html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -# html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -# html_file_suffix = None - -# Output file base name for HTML help builder. -htmlhelp_basename = 'banditReleaseNotesDoc' - - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # 'papersize': 'letterpaper', - - # The font size ('10pt', '11pt' or '12pt'). - # 'pointsize': '10pt', - - # Additional stuff for the LaTeX preamble. - # 'preamble': '', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - ('index', 'banditReleaseNotes.tex', - u'Bandit Release Notes Documentation', - u'Bandit Developers', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -# latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -# latex_use_parts = False - -# If true, show page references after internal links. -# latex_show_pagerefs = False - -# If true, show URL addresses after external links. -# latex_show_urls = False - -# Documents to append as an appendix to all manuals. -# latex_appendices = [] - -# If false, no module index is generated. -# latex_domain_indices = True - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ('index', 'banditReleaseNotes', - u'Bandit Release Notes Documentation', - [u'Bandit Developers'], 1) -] - -# If true, show URL addresses after external links. -# man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ('index', 'banditReleaseNotes', - u'Bandit Release Notes Documentation', - u'Bandit Developers', 'banditReleaseNotes', - 'Python source code security analyzer', - 'Miscellaneous'), -] - -# Documents to append as an appendix to all manuals. -# texinfo_appendices = [] - -# If false, no module index is generated. -# texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -# texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -# texinfo_no_detailmenu = False - -# -- Options for Internationalization output ------------------------------ -locale_dirs = ['locale/'] diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst deleted file mode 100644 index 7b443aacd..000000000 --- a/releasenotes/source/index.rst +++ /dev/null @@ -1,21 +0,0 @@ -.. - Licensed under the Apache License, Version 2.0 (the "License"); you may - not use this file except in compliance with the License. You may obtain - a copy of the License at - - https://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - License for the specific language governing permissions and limitations - under the License. - -==================== -Bandit Release Notes -==================== - - .. toctree:: - :maxdepth: 1 - - unreleased diff --git a/releasenotes/source/unreleased.rst b/releasenotes/source/unreleased.rst deleted file mode 100644 index 5860a4691..000000000 --- a/releasenotes/source/unreleased.rst +++ /dev/null @@ -1,5 +0,0 @@ -========================== - Unreleased Release Notes -========================== - -.. release-notes:: From 3899e3e8eaa047359f80789203189d9014d9955b Mon Sep 17 00:00:00 2001 From: Eric Brown Date: Sat, 29 Jan 2022 00:15:03 -0800 Subject: [PATCH 2/4] Update tox.ini --- tox.ini | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/tox.ini b/tox.ini index 056b5aaba..6f4b3bcfe 100644 --- a/tox.ini +++ b/tox.ini @@ -65,13 +65,9 @@ commands= # [H106] Don't put vim configuration in source files. # [H203] Use assertIs(Not)None to check for None. show-source = True -exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build,releasenotes +exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build enable-extensions = H106,H203 -[testenv:releasenotes] -deps = -r{toxinidir}/doc/requirements.txt -commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html - [testenv:pylint] commands = -pylint --rcfile=pylintrc bandit From 5ef24b01ae5b4a5c4ce3a1c4b7dfe89993c530b2 Mon Sep 17 00:00:00 2001 From: Eric Brown Date: Sat, 29 Jan 2022 00:15:24 -0800 Subject: [PATCH 3/4] Update .pre-commit-config.yaml --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index f61261a9b..8acb8152c 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,4 +1,4 @@ -exclude: ^(examples|tools|doc|releasenotes) +exclude: ^(examples|tools|doc) repos: - repo: https://github.com/pre-commit/pre-commit-hooks rev: v4.0.1 From bf51c3040107b058a39fd92d69f4faae075d42ba Mon Sep 17 00:00:00 2001 From: Eric Brown Date: Sat, 29 Jan 2022 00:16:07 -0800 Subject: [PATCH 4/4] Update .gitignore --- .gitignore | 1 - 1 file changed, 1 deletion(-) diff --git a/.gitignore b/.gitignore index 96ba49288..eca3b6718 100644 --- a/.gitignore +++ b/.gitignore @@ -18,4 +18,3 @@ ChangeLog doc/source/api .*.sw? AUTHORS -releasenotes/build