qctrl-release-noter 0.1.3__tar.gz

qctrl_release_noter-0.1.3/LICENSE

@@ -0,0 +1,174 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.

qctrl_release_noter-0.1.3/PKG-INFO

@@ -0,0 +1,73 @@
+Metadata-Version: 2.1
+Name: qctrl-release-noter
+Version: 0.1.3
+Summary: Q-CTRL Release Noter
+Home-page: https://q-ctrl.com
+License: Apache-2.0
+Keywords: black opal,boulder opal,fire opal,nisq,open controls,q control,q ctrl,q-control,q-ctrl,qcontrol,qctrl,quantum,quantum algorithms,quantum circuits,quantum coding,quantum coding software,quantum computing,quantum control,quantum control software,quantum control theory,quantum engineering,quantum error correction,quantum firmware,quantum fundamentals,quantum sensing,qubit,qudit
+Author: Q-CTRL
+Author-email: support@q-ctrl.com
+Maintainer: Q-CTRL
+Maintainer-email: support@q-ctrl.com
+Requires-Python: >=3.8,<3.12
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Classifier: Topic :: Software Development :: Embedded Systems
+Classifier: Topic :: System :: Distributed Computing
+Requires-Dist: click (>=8.0,<9.0)
+Requires-Dist: gitpython (>=3.1.37,<4.0.0)
+Requires-Dist: packaging (>=23.0,<24.0)
+Requires-Dist: pyinflect (>=0.5.1,<0.6.0)
+Project-URL: Facebook, https://www.facebook.com/qctrl
+Project-URL: GitHub, https://github.com/qctrl
+Project-URL: LinkedIn, https://www.linkedin.com/company/q-ctrl/
+Project-URL: Twitter, https://twitter.com/qctrlHQ
+Project-URL: YouTube, https://www.youtube.com/qctrl
+Description-Content-Type: text/markdown
+
+# Q-CTRL Release Noter
+
+The Q-CTRL Release Noter Python package provides a command line tool that generates the recommended release notes for a GitHub package from Q-CTRL.
+
+## Installation
+
+Install the Q-CTRL Release Noter with:
+
+```shell
+pip install qctrl-release-noter
+```
+
+## Usage
+
+In the repository whose release notes you want to generate, run:
+
+```shell
+release_noter
+```
+
+You can also specify the path of the repository:
+
+```shell
+release_noter /path/to/repository
+```
+
+To prefill the information on the GitHub release page, use:
+
+```shell
+release_noter --github
+```
+

qctrl_release_noter-0.1.3/README.md

@@ -0,0 +1,31 @@
+# Q-CTRL Release Noter
+
+The Q-CTRL Release Noter Python package provides a command line tool that generates the recommended release notes for a GitHub package from Q-CTRL.
+
+## Installation
+
+Install the Q-CTRL Release Noter with:
+
+```shell
+pip install qctrl-release-noter
+```
+
+## Usage
+
+In the repository whose release notes you want to generate, run:
+
+```shell
+release_noter
+```
+
+You can also specify the path of the repository:
+
+```shell
+release_noter /path/to/repository
+```
+
+To prefill the information on the GitHub release page, use:
+
+```shell
+release_noter --github
+```

qctrl_release_noter-0.1.3/pyproject.toml

@@ -0,0 +1,103 @@
+[tool.poetry]
+name = "qctrl-release-noter"
+version = "0.1.3"
+description = "Q-CTRL Release Noter"
+license = "Apache-2.0"
+authors = ["Q-CTRL <support@q-ctrl.com>"]
+maintainers = ["Q-CTRL <support@q-ctrl.com>"]
+readme = "README.md"
+homepage = "https://q-ctrl.com"
+keywords = [
+    "black opal",
+    "boulder opal",
+    "fire opal",
+    "nisq",
+    "open controls",
+    "q control",
+    "q ctrl",
+    "q-control",
+    "q-ctrl",
+    "qcontrol",
+    "qctrl",
+    "quantum",
+    "quantum algorithms",
+    "quantum circuits",
+    "quantum coding",
+    "quantum coding software",
+    "quantum computing",
+    "quantum control",
+    "quantum control software",
+    "quantum control theory",
+    "quantum engineering",
+    "quantum error correction",
+    "quantum firmware",
+    "quantum fundamentals",
+    "quantum sensing",
+    "qubit",
+    "qudit"
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Education",
+    "Intended Audience :: Science/Research",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Topic :: Internet :: WWW/HTTP",
+    "Topic :: Scientific/Engineering :: Physics",
+    "Topic :: Scientific/Engineering :: Visualization",
+    "Topic :: Software Development :: Embedded Systems",
+    "Topic :: System :: Distributed Computing"
+]
+packages = [
+    { include = "qctrlreleasenoter" },
+]
+
+[tool.poetry.urls]
+LinkedIn = "https://www.linkedin.com/company/q-ctrl/"
+Facebook = "https://www.facebook.com/qctrl"
+Twitter = "https://twitter.com/qctrlHQ"
+YouTube = "https://www.youtube.com/qctrl"
+GitHub = "https://github.com/qctrl"
+
+[tool.poetry.scripts]
+release_noter = "qctrlreleasenoter.cli:main"
+
+[tool.poetry.dependencies]
+python = ">=3.8, <3.12"
+click = "^8.0"
+pyinflect = "~0.5.1"
+gitpython = "^3.1.37"
+packaging = "^23.0"
+
+[tool.poetry.dev-dependencies]
+black = "^24.3.0"
+isort = "^5.12.0"
+mypy = "^1.5.1"
+pre-commit = "^3.2.2"
+pylint = "^2.17.5"
+pytest = "^7.4.0"
+
+
+[[tool.poetry.source]]
+name = "PyPI"
+priority = "supplemental"
+
+[[tool.poetry.source]]
+name = "Q-CTRL PyPI"
+url = "https://pypi.q-ctrl.com/simple"
+priority = "primary"
+
+[tool.isort]
+profile = "black"
+force_grid_wrap = "2"
+known_first_party = "qctrlreleasenoter"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

qctrl_release_noter-0.1.3/qctrlreleasenoter/__init__.py

@@ -0,0 +1,20 @@
+# Copyright 2024 Q-CTRL
+#
+# 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
+#
+#    http://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.
+
+"""
+A Python package for generating the recommended release notes.
+"""
+
+__version__ = "0.1.3"
+__author__ = "Q-CTRL <support@q-ctrl.com>"

qctrl_release_noter-0.1.3/qctrlreleasenoter/cli.py

@@ -0,0 +1,101 @@
+# Copyright 2024 Q-CTRL
+#
+# 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
+#
+#    http://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.
+"""
+The CLI tool to generate release note.
+"""
+import click
+from git import (
+    InvalidGitRepositoryError,
+    Repo,
+)
+
+from qctrlreleasenoter.generate_release_notes import (
+    generate_note,
+    pull_latest_changes,
+)
+
+
+@click.command(
+    help="""
+    Prints release notes for the commits between the latest tag and `branch`
+    for the specified repository.
+
+    Commits are expected to follow the Conventional Commits specification
+    (https://www.conventionalcommits.org/en/v1.0.0/). That is, messages are
+    typically expected to be of the form:
+
+        \b
+        <kind>: <title>
+
+        \b
+        <description>
+
+    The valid types and the release type they lead to are defined in the
+    contributing guidelines (https://code.q-ctrl.com/contributing).
+
+    Messages for commits introducing breaking changes are expected to be of
+    the form:
+
+        \b
+        <kind>!: <title>
+
+        \b
+        <description>
+
+        \b
+        BREAKING CHANGE: <explanation of the breaking change>
+    """
+)
+@click.option(
+    "--branch",
+    default="master",
+    help="Branch on which the release will be made (defaults to master).",
+)
+@click.option(
+    "--github",
+    is_flag=True,
+    default=False,
+    help="Open GitHub with the release notes prefilled.",
+)
+@click.option(
+    "--phase",
+    type=click.Choice(["stable", "alpha", "beta"]),
+    default="stable",
+    help="Select the phase for the release (defaults to stable).",
+)
+@click.option(
+    "--pull/--no-pull",
+    default=True,
+    help="Pull the latest changes from remote for the specified --branch (defaults to --pull).",
+)
+@click.option(
+    "--allow-empty",
+    is_flag=True,
+    default=False,
+    help="Create a release notes template even if the release notes would be empty otherwise.",
+)
+@click.argument("path", default=".", type=click.Path(exists=True))
+def main(branch, github, path, phase, allow_empty, pull):
+    """
+    Main entry to generate the release note.
+    """
+    try:
+        repo = Repo(path)
+    except InvalidGitRepositoryError as err:
+        raise RuntimeError("The current directory is not a valid repository.") from err
+
+    if pull:
+        pull_latest_changes(branch, repo)
+
+    generate_note(branch, github, phase, repo, allow_empty)

qctrl_release_noter-0.1.3/qctrlreleasenoter/generate_release_notes.py

@@ -0,0 +1,445 @@
+# Copyright 2024 Q-CTRL
+#
+# 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
+#
+#    http://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.
+
+"""
+Generates release notes based on the commit history since the last release.
+"""
+from __future__ import annotations
+
+import re
+import webbrowser
+from dataclasses import (
+    dataclass,
+    field,
+    fields,
+)
+from enum import Enum
+from functools import partial
+from itertools import islice
+from pathlib import Path
+from typing import (
+    Iterator,
+    Optional,
+)
+from urllib.parse import quote_plus
+
+import click
+import pyinflect
+from git.objects import Commit
+from git.refs.tag import TagReference
+from packaging.version import (
+    VERSION_PATTERN,
+    Version,
+    parse,
+)
+
+
+class _PrType(Enum):
+    MINOR = ("feat",)
+    PATCH = ("fix", "perf", "revert", "build")
+    IGNORED = ("refactor", "chore", "ci", "docs", "style", "test")
+    # Using an empty tuple here seems to cause issue in Python 3.11.1,
+    # as it's treated as an object instead of an iterable.
+    # Therefore, in `_classify_commit_type` we exclude the UNKNOWN item.
+    UNKNOWN = ()
+
+
+def _classify_commit_type(kind: str) -> _PrType:
+    """
+    Classify the PR type for a commit based on its kind.
+    This could be a classmethod of _PrType, but it's convenient for type-checking as
+    a private function.
+    """
+    # Classify the types for valid PRs in the release note.
+    for type_ in islice(_PrType, len(_PrType) - 1):
+        if kind in type_.value:
+            return type_
+    # Label the invalid PR.
+    return _PrType.UNKNOWN
+
+
+@dataclass
+class _CommitInfo:
+    title: str
+    kind: _PrType
+    sha: Optional[str]
+    breaking_change_message: Optional[str]
+
+
+class _ReleasePhase(Enum):
+    ALPHA = "alpha"
+    BETA = "beta"
+    STABLE = "stable"
+
+
+@dataclass
+class NoteBody:
+    """
+    Dataclass to hold the body of release note.
+    """
+
+    major: list[str] = field(default_factory=list)
+    minor: list[str] = field(default_factory=list)
+    patch: list[str] = field(default_factory=list)
+    unknown: list[str] = field(default_factory=list)
+
+    def is_empty(self) -> bool:
+        """
+        Check whether the note body is empty.
+        """
+        return (
+            sum(
+                map(
+                    len, (getattr(self, field.name) for field in fields(self.__class__))
+                )
+            )
+            == 0
+        )
+
+    def add_item(self, item: _CommitInfo) -> None:
+        """
+        Update note body from a commit item.
+        """
+        # Handle the breaking change first since
+        # any valid PR could be a breaking one.
+        if item.breaking_change_message is not None:
+            self.major.append(item.breaking_change_message)
+
+        if item.kind is _PrType.IGNORED:
+            return
+        if item.kind is _PrType.UNKNOWN:
+            print_warning(
+                f"Commit {item.sha} has unknown kind {item.kind!r}, "
+                "appending to unknown changes."
+            )
+            self.unknown.append(convert_to_past_tense(item.title))
+        else:
+            pr_type = getattr(self, item.kind.name.lower())
+            pr_type.append(convert_to_past_tense(item.title))
+
+
+def pull_latest_changes(branch, repo):
+    """
+    Pulls the latest changes from remote for the specified `branch`.
+    """
+    repo.git.checkout(branch)
+    repo.remotes.origin.pull()
+
+
+def is_version(tag: TagReference) -> bool:
+    """
+    Use packaging.version's regex to determine if a tag name is a valid version.
+    See also: https://packaging.pypa.io/en/stable/version.html
+    """
+    return (
+        re.match(VERSION_PATTERN, tag.name, flags=re.VERBOSE | re.IGNORECASE)
+        is not None
+    )
+
+
+def generate_note(branch, github, phase, repo, allow_empty):
+    """
+    Generate release notes for the commits between the latest tag and `branch`.
+    """
+
+    # Filter to tags that look like versions, and then find the most recent.
+    tags = filter(is_version, repo.tags)
+    latest_tag = max(tags, key=lambda tag: tag.commit.committed_date, default=None)
+    if latest_tag is not None:
+        latest_tag_name = latest_tag.name
+        commits = repo.iter_commits(f"{latest_tag_name}..{branch}", reverse=True)
+    else:
+        # Meaning this is the first release of the target repo.
+        latest_tag_name = None
+        commits = repo.iter_commits(reverse=True)
+
+    note_body = generate_note_from_commits(commits)
+    if note_body.is_empty():
+        if not allow_empty:
+            print_warning(
+                "No correctly formatted changes detected. "
+                "You can use --allow-empty to create a release notes template."
+            )
+            return
+        note_body = generate_empty_note()
+        print_warning(
+            "No correctly formatted changes detected. "
+            "Remember to update the template before releasing the new version."
+        )
+
+    # Suggest a new version number based on the changes we found.
+    # If this is the first release, starting from "0.0.0".
+    version = Version("0.0.0") if latest_tag_name is None else parse(latest_tag_name)
+    assert isinstance(version, Version)
+    project_name = None
+    # Attempts to fetch the name of the project from the README title.
+    readme_locations = [
+        f"{repo.working_dir}/.github/README.md",
+        f"{repo.working_dir}/README.md",
+    ]
+    for filepath in readme_locations:
+        if Path(filepath).is_file():
+            with open(filepath, "r", encoding="utf8") as file:
+                header = re.search(
+                    "^(?: *)#(?: *)(.+)(?: *)$", file.read(), re.MULTILINE
+                )
+            if header is not None:
+                project_name = header.group(1)
+                break
+
+    if project_name is None:
+        print_warning("No project name found. Release name will not be suggested.")
+
+    try:
+        release_phase = _ReleasePhase[phase.upper()]
+    except KeyError as err:
+        raise RuntimeError(f"Unknown release phase: {phase}.") from err
+
+    query_parameters = {
+        "tag": get_new_version_tag(
+            release_phase=release_phase,
+            current_version=version,
+            has_major_changes=len(note_body.major) > 0,
+            has_minor_changes=len(note_body.minor) > 0,
+        )
+    }
+
+    click.echo(f"Suggested version: {query_parameters['tag']}")
+    if project_name is not None:
+        query_parameters["title"] = f"{project_name} {query_parameters['tag']}"
+        click.echo(f"Suggested title: {query_parameters['title']}")
+    click.echo("")
+
+    # Create summary of changes.
+    change_list = []
+    for items, title in [
+        (note_body.unknown, "UNKNOWN CHANGES"),
+        (note_body.major, "Major changes"),
+        (note_body.minor, "Minor changes"),
+        (note_body.patch, "Patch changes"),
+    ]:
+        if not items:
+            continue
+        change_list += [title]
+        formatted_items = [format_list_item(item) for item in items]
+        change_list += ["\n".join(formatted_items)]
+    query_parameters["body"] = "\n\n".join(change_list)
+
+    click.echo(query_parameters["body"])
+    click.echo("")
+
+    if github:
+        if len(repo.remotes) == 0:
+            print_warning("No remote repo found, cannot redirect to GitHub.")
+            return
+        if len(repo.remotes) > 1:
+            print_warning("More than one remote repo found, cannot redirect to GitHub.")
+            return
+        match = re.search(
+            "^https://github.com/(.*).git$|^git@github.com:(.*).git$",
+            repo.remotes.origin.url,
+        )
+        if match is None:
+            print_warning("Remote repository is not on GitHub, cannot redirect.")
+            return
+        repo_url = f"https://github.com/{match.groups()[0] or match.groups()[1]}"
+        parsed_parameters = "&".join(
+            [f"{key}={quote_plus(value)}" for key, value in query_parameters.items()]
+        )
+        if project_name is None:
+            print_warning("Project name not found, cannot redirect to GitHub.")
+            return
+        webbrowser.open(f"{repo_url}/releases/new?{parsed_parameters}")
+
+
+def _get_commit_info(commit: Commit) -> Optional[_CommitInfo]:
+    """
+    Extract relevant parts from the commit message.
+    """
+    message = commit.message
+    assert isinstance(message, str)
+
+    title_match = re.match("(?:(?P<kind>[a-z]*)(?P<break>!)?: )?(?P<title>.*)", message)
+
+    # For now, this branch is never triggered since the title group in the
+    # regex pattern above will match any string. This mainly serves as
+    # a type-checking for mypy at the moment. We can revise this if we
+    # change the regex pattern later.
+    if title_match is None:
+        print_warning(
+            f"Commit {commit.hexsha} has incorrectly formatted "
+            f"title {message.splitlines()[0]}, ignoring."
+        )
+        return None
+
+    kind = title_match.groupdict()["kind"]
+    title = title_match.groupdict()["title"]
+
+    assert isinstance(title, str)
+
+    # See whether this commit is a breaking change. We need to check both
+    # the title for an exclamation mark and the description for BREAKING
+    # CHANGE (we check for BREAKING-CHANGE too, as per Conventional
+    # Commits).
+    breaking_change_message = None
+    breaking_description_match = re.search("BREAKING(?: |-)CHANGE:", message)
+    if breaking_description_match:
+        breaking_change_message = message[breaking_description_match.end() :]
+    elif title_match.groupdict()["break"]:
+        print_warning(
+            f"Commit {commit.hexsha} is missing a breaking change "
+            "description, using commit title instead."
+        )
+        breaking_change_message = convert_to_past_tense(title)
+
+    return _CommitInfo(
+        title=title,
+        kind=_classify_commit_type(kind),
+        sha=commit.hexsha,
+        breaking_change_message=breaking_change_message,
+    )
+
+
+def generate_note_from_commits(commits: Iterator[Commit]) -> NoteBody:
+    """
+    Iterate through commits, collecting information about major, minor, and patch changes.
+    """
+
+    note_body = NoteBody()
+    for commit in commits:
+        commit_info = _get_commit_info(commit)
+        if commit_info is None:
+            continue
+        note_body.add_item(commit_info)
+    return note_body
+
+
+def generate_empty_note() -> NoteBody:
+    """
+    Create a template for empty release note.
+    """
+    note_body = NoteBody()
+    title = (
+        "No changes found. Add a description of the changes that require the release"
+    )
+    note_body.add_item(
+        _CommitInfo(
+            title=title, kind=_PrType.PATCH, sha=None, breaking_change_message=None
+        )
+    )
+    return note_body
+
+
+def get_new_version_tag(
+    release_phase: _ReleasePhase,
+    current_version: Version,
+    has_major_changes: bool,
+    has_minor_changes: bool,
+) -> str:
+    """
+    Get the version tag for the next release.
+    """
+    if release_phase is _ReleasePhase.STABLE:
+        _release_func = _stable_release
+    else:
+        _release_func = partial(_pre_release, phase=release_phase)
+    return _release_func(
+        current_version,
+        has_major_changes=has_major_changes,
+        has_minor_changes=has_minor_changes,
+    )
+
+
+def _pre_release(
+    current_version: Version,
+    has_major_changes: bool,
+    has_minor_changes: bool,
+    phase: _ReleasePhase,
+) -> str:
+    if current_version.is_prerelease:
+        assert current_version.pre is not None  # for mypy
+        current_pre_version, pre_version_num = current_version.pre
+        if current_pre_version == "b" and phase is _ReleasePhase.ALPHA:
+            print_warning(
+                "Releasing an alpha version after a beta version means "
+                "a stable version is skipped."
+            )
+        # Jumping between pre release phases would reset the pre version number.
+        _num = 0 if current_pre_version != phase.value[0] else pre_version_num + 1
+        return f"{current_version.base_version}-{phase.value}.{_num}"
+    return f"{_stable_release(current_version, has_major_changes, has_minor_changes)}-{phase.value}"
+
+
+def _stable_release(
+    current_version: Version, has_major_changes: bool, has_minor_changes: bool
+) -> str:
+    # pre -> stable
+    if current_version.is_prerelease:
+        return current_version.base_version
+
+    # stable -> stable
+    major, minor, patch = current_version.release
+    if has_major_changes:
+        if major > 0:
+            major += 1
+            minor = 0
+            patch = 0
+        else:
+            minor += 1
+            patch = 0
+    elif has_minor_changes:
+        minor += 1
+        patch = 0
+    else:
+        patch += 1
+    return f"{major}.{minor}.{patch}"
+
+
+def convert_to_past_tense(text: str) -> str:
+    """
+    Tries to convert the given text to past tense.
+    """
+    # Convert the first word to past tense if possible, otherwise just leave the
+    # text unchanged.
+    parts = text.split(" ", 1)
+    past_tense = pyinflect.getInflection(parts[0], "VBD")
+    if past_tense:
+        parts[0] = past_tense[0]
+    return " ".join(parts)
+
+
+def format_list_item(text: str) -> str:
+    """
+    Formats text (which might contain newlines) into a Markdown list item.
+    """
+    text = text.strip()
+
+    # Capitalize first word and add period if necessary.
+    parts = text.split(" ", 1)
+    parts[0] = parts[0].capitalize()
+    text = " ".join(parts)
+    if text[-1] not in ".?!":
+        text += "."
+
+    # Indent subsequent lines.
+    indented = "\n  ".join([line.strip() for line in text.splitlines()])
+
+    return f"- {indented}"
+
+
+def print_warning(message: str):
+    """
+    Prints a warning message to stderr.
+    """
+    click.echo(click.style(message, fg="red"), err=True)