Skip to content

Commit

Permalink
Create antsibull-stub package config for backwards compatibility
Browse files Browse the repository at this point in the history
This project can be published to PyPI to maintain backwards
compatibility.
  • Loading branch information
gotmax23 authored and felixfontein committed Oct 13, 2024
1 parent 2d3fe0f commit 71737c2
Show file tree
Hide file tree
Showing 5 changed files with 84 additions and 0 deletions.
1 change: 1 addition & 0 deletions antsibull-stub/LICENSE
1 change: 1 addition & 0 deletions antsibull-stub/LICENSES
10 changes: 10 additions & 0 deletions antsibull-stub/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<!--
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
-->

# antsibull PyPI stub package

The `antsibull` project has been renamed to `antsibull-build`.
This is an empty stub package for backwards compatibility.
60 changes: 60 additions & 0 deletions antsibull-stub/pyproject.toml
Original file line number Diff line number Diff line change
@@ -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 = "[email protected]"

[[project.authors]]
name = "Felix Fontein"
email = "[email protected]"

[[project.maintainers]]
name = "Felix Fontein"
email = "[email protected]"

[[project.maintainers]]
name = "Maxwell G"
email = "[email protected]"

[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
12 changes: 12 additions & 0 deletions changelogs/fragments/629-antsibull-stub.yaml
Original file line number Diff line number Diff line change
@@ -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)."

0 comments on commit 71737c2

Please sign in to comment.