repo: Adopt towncrier for changelog management (#95)

achimnol · web-flow · commit cae20103bb77 · 2020-04-07T00:15:05.000+09:00
* Add towncier configs
* Migrate in-dev changelog to towncrier
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,16 @@
+# 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 refer
+    https://pip.pypa.io/en/latest/development/contributing/#news-entries
+
+    We named the news folder "changes".
+
+    WARNING: Don't drop the last line!
+-->
+
+.. towncrier release notes start
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -1,60 +1,6 @@
 Changes
 =======
 
-20.03.0b2 (2020-04-xx)
-----------------------
-
-* FIX: Improve exception handling in ``backend.ai app`` command
-  and internally update backend.ai-cli package to work consistently
-  with #93 (#94)
-
-19.12.0b1 (2020-01-11)
-----------------------
-
-* NEW: dotfiles management API and CLI (#85)
-
-* BREAKING CHANGE: All functional API classes are moved into the
-  ``ai.backend.client.func`` sub-package. (#82)
-
-  - ``Kernel`` is changed to ``Session``.
-
-  - The session ID field name in the response of ``Session`` objects
-    is now ``session_id`` instead of ``kernel_id``.
-
-  - Except above, this would not introduce big changes in the SDK user
-    codes since they use ``AsyncSession`` and ``Session`` in the
-    ``ai.backend.client.session`` module.
-
-* NEW: Automatic API version negotiation when entering session contexts.
-  (#79, #82)
-
-  - ``backend.ai config`` command now displays the server/client component
-    and API versions with negotiated API version if available.
-
-  - It supports both the v19.09 (API v4.20190615) and v19.12 (API
-    v5.20191215) API gateways.
-
-    Regardless of the server API version, the client SDK users may use the
-    same ``Session`` function API.
-
-  - It generates an explicit warning for when server-side version is higher
-    to guide users to upgrade their packages.
-
-* NEW: ``--format`` and ``--plain`` options for ``backend.ai ps`` command
-  to customize the output table format (#80)
-
-* NEW: SDK API (``SessionTemplate``) and CLI command set (``backend.ai sesstpl``)
-
-* NEW: Support for unmanaged vfolders and token-based download API (#77)
-
-* FIX: Refine details of the ``app`` command such as error handling (#90)
-
-19.12.0a1 (2019-11-17)
-----------------------
-
-* BREAKING CHANGE: Now the client SDK runs on Python 3.6, 3.7, and 3.8 and
-  dropped support for Python 3.5.
-
 19.09.7 (2020-03-31)
 --------------------
 
diff --git a/changes/0.breaking b/changes/0.breaking
@@ -0,0 +1 @@
+Now the client SDK runs on Python 3.6, 3.7, and 3.8 and dropped support for Python 3.5.
diff --git a/changes/0.feature b/changes/0.feature
@@ -0,0 +1 @@
+- Add SDK API (`SessionTemplate`) and CLI command set (`backend.ai sesstpl`)
diff --git a/changes/77.feature b/changes/77.feature
@@ -0,0 +1 @@
+Support for unmanaged vfolders and token-based download API
diff --git a/changes/79.feature b/changes/79.feature
@@ -0,0 +1 @@
+`backend.ai config` command now displays the server/client component and API versions with negotiated API version if available.
diff --git a/changes/80.feature b/changes/80.feature
@@ -0,0 +1 @@
+Add `--format` and `--plain` options to `backend.ai ps` command to customize the output table format
diff --git a/changes/82.breaking b/changes/82.breaking
@@ -0,0 +1,7 @@
+All functional API classes are moved into the `ai.backend.client.func` sub-package.
+- `Kernel` is changed to `Session`.
+- The session ID field name in the response of `Session` objects
+  is now `session_id` instead of `kernel_id`.
+- Except above, this would not introduce big changes in the SDK user
+  codes since they use `AsyncSession` and `Session` in the
+  `ai.backend.client.session` module.
diff --git a/changes/82.feature b/changes/82.feature
@@ -0,0 +1 @@
+Perform automatic API version negotiation when entering session contexts while keeping the functional API same
diff --git a/changes/85.feature b/changes/85.feature
@@ -0,0 +1 @@
+Support dotfiles management API and CLI
diff --git a/changes/90.fix b/changes/90.fix
@@ -0,0 +1 @@
+Refine details of the `app` command such as error handling
diff --git a/changes/94.fix b/changes/94.fix
@@ -0,0 +1 @@
+Improve exception handling in ``backend.ai app`` command and update backend.ai-cli package
diff --git a/changes/95.misc b/changes/95.misc
@@ -0,0 +1 @@
+Adopt [towncrier](https://github.com/twisted/towncrier) for changelog management
diff --git a/changes/template.md b/changes/template.md
@@ -0,0 +1,39 @@
+{%- for section, _ in sections.items() -%}
+  {%- if section %}
+## {{ section }}
+  {%- endif -%}
+  {%- if sections[section] -%}
+    {%- for category, val in definitions.items() if category in sections[section] %}
+
+
+### {{ definitions[category]['name'] }}
+
+      {%- if definitions[category]['showcontent'] %}
+        {%- for text, values in sections[section][category].items() %}
+          {%- if values[0].endswith("/0)") %}
+
+* {{ definitions[category]['name'] }} without explicit PR/issue numbers
+  {{ text }}
+          {%- else %}
+
+* {{ text }}
+  {{ values|join(',\n  ') }}
+          {%- endif %}
+
+        {%- 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/pyproject.toml b/pyproject.toml
@@ -0,0 +1,38 @@
+[tool.towncrier]
+package = "ai.backend.client"
+filename = "CHANGELOG.md"
+directory = "changes/"
+title_format = "## {version} ({project_date})"
+template = "changes/template.md"
+issue_format = "[(#{issue})](https://github.com/lablup/backend.ai-client-py/issues/{issue})"
+underlines = ["", "", ""]
+
+[[tool.towncrier.type]]
+    directory = "breaking"
+    name = "Breaking Changes"
+    showcontent = true
+
+[[tool.towncrier.type]]
+    directory = "feature"
+    name = "Features"
+    showcontent = true
+
+[[tool.towncrier.type]]
+    directory = "deprecation"
+    name = "Deprecations"
+    showcontent = true
+
+[[tool.towncrier.type]]
+    directory = "fix"
+    name = "Fixes"
+    showcontent = true
+
+[[tool.towncrier.type]]
+    directory = "doc"
+    name = "Documentation Changes"
+    showcontent = true
+
+[[tool.towncrier.type]]
+    directory = "misc"
+    name = "Miscellaneous"
+    showcontent = true
diff --git a/setup.py b/setup.py
@@ -24,6 +24,7 @@
 build_requires = [
     'wheel>=0.34.2',
     'twine>=3.1.1',
+    'towncrier>=19.2.0',
 ]
 test_requires = [
     'pytest~=5.4.1',

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Now the client SDK runs on Python 3.6, 3.7, and 3.8 and dropped support for Python 3.5.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+- Add SDK API (`SessionTemplate`) and CLI command set (`backend.ai sesstpl`)
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Support for unmanaged vfolders and token-based download API`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+`backend.ai config` command now displays the server/client component and API versions with negotiated API version if available.
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+Add `--format` and `--plain` options to `backend.ai ps` command to customize the output table format
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Perform automatic API version negotiation when entering session contexts while keeping the functional API same`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Support dotfiles management API and CLI`