From 71737c23abb17675c4cb881c591cc727e0f1681a Mon Sep 17 00:00:00 2001 From: Maxwell G Date: Mon, 30 Sep 2024 22:21:49 -0500 Subject: [PATCH] Create antsibull-stub package config for backwards compatibility This project can be published to PyPI to maintain backwards compatibility. --- antsibull-stub/LICENSE | 1 + antsibull-stub/LICENSES | 1 + antsibull-stub/README.md | 10 ++++ antsibull-stub/pyproject.toml | 60 ++++++++++++++++++++ changelogs/fragments/629-antsibull-stub.yaml | 12 ++++ 5 files changed, 84 insertions(+) create mode 120000 antsibull-stub/LICENSE create mode 120000 antsibull-stub/LICENSES create mode 100644 antsibull-stub/README.md create mode 100644 antsibull-stub/pyproject.toml create mode 100644 changelogs/fragments/629-antsibull-stub.yaml diff --git a/antsibull-stub/LICENSE b/antsibull-stub/LICENSE new file mode 120000 index 00000000..ea5b6064 --- /dev/null +++ b/antsibull-stub/LICENSE @@ -0,0 +1 @@ +../LICENSE \ No newline at end of file diff --git a/antsibull-stub/LICENSES b/antsibull-stub/LICENSES new file mode 120000 index 00000000..fafe4e47 --- /dev/null +++ b/antsibull-stub/LICENSES @@ -0,0 +1 @@ +../LICENSES \ No newline at end of file diff --git a/antsibull-stub/README.md b/antsibull-stub/README.md new file mode 100644 index 00000000..4bf7e699 --- /dev/null +++ b/antsibull-stub/README.md @@ -0,0 +1,10 @@ + + +# antsibull PyPI stub package + +The `antsibull` project has been renamed to `antsibull-build`. +This is an empty stub package for backwards compatibility. diff --git a/antsibull-stub/pyproject.toml b/antsibull-stub/pyproject.toml new file mode 100644 index 00000000..92ea4ccc --- /dev/null +++ b/antsibull-stub/pyproject.toml @@ -0,0 +1,60 @@ +# Copyright (c) Ansible Project +# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) +# SPDX-License-Identifier: GPL-3.0-or-later + +[build-system] +requires = ["hatchling"] +build-backend = "hatchling.build" + +[project] +name = "antsibull" +version = "0.66.0" +description = "The antsibull project has been renamed to antsibull-build" +license = "GPL-3.0-or-later AND Python-2.0.1" +license-files = {globs=["LICENSES/*.txt"]} +readme = "README.md" +classifiers = [ + "Development Status :: 5 - Production/Stable", + "Framework :: Ansible", + "Intended Audience :: Developers", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Typing :: Typed", +] +requires-python = ">=3.9" +dependencies = [ + "antsibull-build>=0.66.0" +] + +[[project.authors]] +name = "Toshio Kuratomi" +email = "a.badger@gmail.com" + +[[project.authors]] +name = "Felix Fontein" +email = "felix@fontein.de" + +[[project.maintainers]] +name = "Felix Fontein" +email = "felix@fontein.de" + +[[project.maintainers]] +name = "Maxwell G" +email = "maxwell@gtmx.me" + +[project.urls] +"New package" = "https://pypi.org/project/antsibull-build" + +[project.optional-dependencies] +# User-facing extras +clipboard = [ + "antsibull-build[clipboard]" +] +all = [ + "antsibull-build[all]", +] + +[tool.hatch.build.targets.wheel] +# This is an empty package +bypass-selection = true diff --git a/changelogs/fragments/629-antsibull-stub.yaml b/changelogs/fragments/629-antsibull-stub.yaml new file mode 100644 index 00000000..916847d7 --- /dev/null +++ b/changelogs/fragments/629-antsibull-stub.yaml @@ -0,0 +1,12 @@ +--- +breaking_changes: + - "The name of this project has been changed from ``antsibull`` to + ``antsibull-build`` to reflect that it provides the ``antsibull-build`` + command and disambiguate this project from the other antsibull projects. + For backwards compatibility purposes, the ``antsibull`` project on PyPI + has been converted to an empty stub package that requires + ``antsibull-build``, but users should immediately switch to the new name. + The Git repository has also been moved to + https://github.com/ansible-community/antsibull-build + (https://github.com/ansible-community/antsibull/issues/627, + https://github.com/ansible-community/antsibull/pull/629)."