Problem: towncrier not integrated into plugin

Solution: add towncrier [noissue]
pulp · Aug 6, 2019 · b8356f3 · b8356f3
1 parent 7f69c6f
commit b8356f3
Show file tree

Hide file tree

Showing 15 changed files with 100 additions and 18 deletions.
diff --git a/.travis/publish_plugin_pypi.sh b/.travis/publish_plugin_pypi.sh
@@ -10,4 +10,4 @@
 pip install twine
 
 python setup.py sdist bdist_wheel --python-tag py3
-twine upload dist/* -u None -p $PYPI_PASSWORD
+twine upload dist/* -u pulp -p $PYPI_PASSWORD
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -0,0 +1,14 @@
+=========
+Changelog
+=========
+
+..
+    You should *NOT* be adding new change log entries to this file, this
+    file is managed by towncrier. You *may* edit previous change logs to
+    fix problems like typo corrections or such.
+    To add a new change log entry, please see
+    https://docs.pulpproject.org/en/3.0/nightly/contributing/git.html#changelog-update
+
+    WARNING: Don't drop the next directive!
+
+.. towncrier release notes start
diff --git a/CHANGES/.TEMPLATE.rst b/CHANGES/.TEMPLATE.rst
@@ -0,0 +1,37 @@
+
+{# TOWNCRIER TEMPLATE #}
+{% for section, _ in sections.items() %}
+{% set underline = underlines[0] %}{% if section %}{{section}}
+{{ underline * section|length }}{% set underline = underlines[1] %}
+
+{% endif %}
+
+{% if sections[section] %}
+{% for category, val in definitions.items() if category in sections[section]%}
+{{ definitions[category]['name'] }}
+{{ underline * definitions[category]['name']|length }}
+
+{% if definitions[category]['showcontent'] %}
+{% for text, values in sections[section][category].items() %}
+- {{ text }}
+  {{ values|join(',\n  ') }}
+{% endfor %}
+
+{% else %}
+- {{ sections[section][category]['']|join(', ') }}
+
+{% endif %}
+{% if sections[section][category]|length == 0 %}
+No significant changes.
+
+{% else %}
+{% endif %}
+
+{% endfor %}
+{% else %}
+No significant changes.
+
+
+{% endif %}
+{% endfor %}
+----
diff --git a/CHANGES/.gitignore b/CHANGES/.gitignore
@@ -0,0 +1 @@
+!.gitignore
diff --git a/CHANGES/5217.bugfix b/CHANGES/5217.bugfix
@@ -0,0 +1 @@
+Updates serializers and tests to make plugin compatible with pulpcore-plugin 0.1.0rc4.
diff --git a/HISTORY.rst b/HISTORY.rst
diff --git a/doc_requirements.txt b/doc_requirements.txt
@@ -0,0 +1,2 @@
+sphinx
+towncrier
diff --git a/docs/changes.rst b/docs/changes.rst
@@ -0,0 +1,5 @@
+.. _pulp-maven-changes:
+
+.. include:: ../CHANGES.rst
+
+.. include:: ../HISTORY.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -11,10 +11,11 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-try:
-    import sphinx_rtd_theme
-except ImportError:
-    sphinx_rtd_theme = False
+import os
+import sys
+sys.path.insert(0, os.path.abspath('..'))  # noqa
+
+import pulp_maven
 
 # 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
@@ -51,9 +52,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = "2.0a1"
+version = pulp_maven.__version__
 # The full version, including alpha/beta/rc tags.
-release = "2.0a1"
+release = pulp_maven.__version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -94,7 +95,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = "sphinx_rtd_theme" if sphinx_rtd_theme else "default"
+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
@@ -123,7 +124,7 @@
 # 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_theme_path = [sphinx_rtd_theme.get_html_theme_path()] if sphinx_rtd_theme else []
+# html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] if sphinx_rtd_theme else []
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.

diff --git a/docs/index.rst b/docs/index.rst
@@ -18,7 +18,7 @@ Table of Contents
 
    installation
    workflows/index
-   release-notes/3.0.z.rst
+   changes
 
 
 Indices and tables

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -4,7 +4,7 @@ User Setup
 All REST API examples below use `httpie <https://httpie.org/doc>`__ to
 perform the requests.
 
-.. code-block::
+.. code-block:: bash
 
     machine localhost
     login admin

diff --git a/docs/release-notes/0.0.z.rst b/docs/release-notes/0.0.z.rst
diff --git a/pulp_maven/__init__.py b/pulp_maven/__init__.py
@@ -1,3 +1,5 @@
-__version__ = "0.1.0b3.dev"
+import pkg_resources
+
+__version__ = pkg_resources.get_distribution("pulp_maven").version
 
 default_app_config = "pulp_maven.app.PulpMavenPluginAppConfig"
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,24 @@
+[tool.towncrier]
+package = "pulp_maven"
+filename = "CHANGES.rst"
+directory = "CHANGES/"
+title_format = "{version} ({project_date})"
+template = "CHANGES/.TEMPLATE.rst"
+issue_format = "`#{issue} <https://pulp.plan.io/issues/{issue}>`_"
+
+[tool.black]
+line-length = 100
+target-version = ["py36", "py37"]
+exclude = '''
+/(
+    \.eggs
+  | \.git
+  | \.venv
+  | _build
+  | build
+  | dist
+  | migrations
+  | docs
+)/
+'''
+
diff --git a/template_config.yml b/template_config.yml
@@ -21,7 +21,7 @@ deploy_to_pypi: True
 docs_test: True
 pydocstyle: True
 test_bindings: False
-pypi_username: None
+pypi_username: pulp
 travis_notifications: None