Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Set up antsibull-core v3 development #127

Merged
merged 1 commit into from
Dec 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 20 additions & 11 deletions .github/workflows/antsibull-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,34 +30,43 @@ jobs:
with:
path: antsibull-core

- name: Checkout antsibull-docs-parser main
uses: actions/checkout@v4
with:
repository: ansible-community/antsibull-docs-parser
ref: main
path: antsibull-docs-parser

# nb: this is the first version of antsibull-docs that declares support
# for antsibull-core v2
felixfontein marked this conversation as resolved.
Show resolved Hide resolved
- name: Check out antsibull-docs 1.8.0
# for antsibull-core v3.
# TODO: Change ref to a released version once antsibull-docs officially
# supports antsibull-core.
- name: Check out antsibull-docs main
uses: actions/checkout@v4
with:
repository: ansible-community/antsibull-docs
ref: 1.8.0
ref: main
path: antsibull-docs

- name: Set up Python 3.11
id: python
uses: actions/setup-python@v5
with:
python-version: '3.11'

- name: Install dependencies
env:
PYTHON: "${{ steps.python.outputs.python-path }}"
run: |
python3 -m venv venv
pipx install --python "${PYTHON}" nox
python -m venv venv
. ./venv/bin/activate
python -m pip install --upgrade pip
python -m pip install . ../antsibull-core "pyre-check ~= 0.9"
python -m pip install . ../antsibull-core
working-directory: antsibull-docs

# pyre should complain if a signature changed in an incompatible way
- name: Lint with pyre
- name: Run type checkers
run: |
. ./venv/bin/activate
sed -i 's|poetry run||' ./lint-pyre.sh
./lint-pyre.sh
nox -e typing
working-directory: antsibull-docs

- name: Use antsibull-docs sphinx-init
Expand Down
25 changes: 14 additions & 11 deletions .github/workflows/antsibull.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,35 +38,38 @@ jobs:
ref: 0.14.0
path: antsibull-changelog

# nb: this is the first version of antsibull that declares support for antsibull-core v2
- name: Check out antsibull 0.52.0
# nb: this is the first version of antsibull that declares support
# for antsibull-core v3.
# TODO: Change ref to a released version once antsibull officially
# supports antsibull-core.
- name: Check out antsibull main
uses: actions/checkout@v4
with:
repository: ansible-community/antsibull
ref: 0.52.0
ref: main
path: antsibull

- name: Set up Python 3.11
id: python
uses: actions/setup-python@v5
with:
python-version: '3.11'

- name: Install dependencies
env:
PYTHON: "${{ steps.python.outputs.python-path }}"
run: |
pipx install --python "${PYTHON}" nox
python -m venv venv
. ./venv/bin/activate
python -m pip install --upgrade pip
python -m pip install . ../antsibull-changelog ../antsibull-core "pyre-check ~= 0.9" ansible-core "wheel"
python -m pip install . ../antsibull-core ../antsibull-changelog
ansible-galaxy collection install community.general
working-directory: antsibull

# pyre should complain if a signature changed in an incompatible way
- name: Lint with pyre
- name: Run type checkers
run: |
. ./venv/bin/activate
sed -i 's|poetry run||' ./lint-pyre.sh
sed -i 's|--search-path ../antsibull-docs/src/||' ./lint-pyre.sh
./lint-pyre.sh
touch ../antsibull-changelog/src/antsibull_changelog/py.typed
nox -e typing
working-directory: antsibull

- name: "Test building a release: Ansible 7 with ansible-core 2.14"
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ antsibull-core is covered by the [Ansible Code of Conduct](https://docs.ansible.

From version 1.0.0 on, antsibull-core sticks to semantic versioning and aims at providing no backwards compatibility breaking changes during a major release cycle. We might make exceptions from this in case of security fixes for vulnerabilities that are severe enough.

The current major version is 2.x.y. Development for 2.x.y occurs on the `main` branch. 1.x.y is End of Life and was developed on the `stable-1` branch. It is no longer updated. 2.x.y mainly differs from 1.x.y by dropping support for Python 3.6, 3.7, and 3.8. It deprecates several compatibility functions for older Python versions that are no longer needed; see the changelog for details.
The current development version is 3.x.y. 3.x.y is developed on the `main` branch. The current supported major version is 2.x.y. Development for 2.x.y occurs on the `stable-2` branch. 1.x.y is End of Life and was developed on the `stable-1` branch. It is no longer updated. 2.x.y mainly differs from 1.x.y by dropping support for Python 3.6, 3.7, and 3.8. It deprecates several compatibility functions for older Python versions that are no longer needed; see the changelog for details.

## Development

Expand Down
2 changes: 1 addition & 1 deletion src/antsibull_core/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@

from __future__ import annotations

__version__ = "2.2.0.post0"
__version__ = "3.0.0.dev0"

__all__ = ("__version__",)