Skip to content

Commit

Permalink
antsibull has been renamed to antsibull-build. (#483)
Browse files Browse the repository at this point in the history
  • Loading branch information
felixfontein authored Oct 18, 2024
1 parent 03200d5 commit ecb4239
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 36 deletions.
28 changes: 14 additions & 14 deletions .github/workflows/ansible-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,21 +48,21 @@ jobs:
pr_url: ${{ steps.create-pr.outputs.pr_url }}

steps:
- name: Check out antsibull
- name: Check out antsibull-build
uses: actions/checkout@v4
with:
repository: ansible-community/antsibull
repository: ansible-community/antsibull-build
ref: main
path: antsibull
path: antsibull-build

- name: Pre-create build directory
run: mkdir -p antsibull/build
run: mkdir -p antsibull-build/build

- name: Check out ansible-build-data under antsibull build directory
- name: Check out ansible-build-data under antsibull-build build directory
uses: actions/checkout@v4
with:
# This is where the antsibull build-release role expects it by default
path: antsibull/build/ansible-build-data
# This is where the antsibull-build build-release role expects it by default
path: antsibull-build/build/ansible-build-data
ref: ${{ inputs.existing-branch || '' }}

- name: Set up Python 3.11
Expand All @@ -71,9 +71,9 @@ jobs:
python-version: 3.11

- name: Install dependencies
working-directory: antsibull
working-directory: antsibull-build
run: |
python3 -m pip install packaging ansible-core antsibull
python3 -m pip install packaging ansible-core antsibull-build
ansible-galaxy install -r requirements.yml
- name: Validate version and extract major version
Expand Down Expand Up @@ -105,7 +105,7 @@ jobs:
- name: Checking out to a new branch
if: inputs.existing-branch == ''
working-directory: antsibull/build/ansible-build-data
working-directory: antsibull-build/build/ansible-build-data
run: |
git checkout -b "${ANSIBLE_BRANCH_NAME}"
Expand All @@ -117,7 +117,7 @@ jobs:
# Run the playbook according to the current release process

- name: Building a release with the defaults
working-directory: antsibull
working-directory: antsibull-build
env:
PRESERVE_DEPS: ${{ inputs.preserve-deps }}
ALLOW_RESET_BUILD_DEPS: ${{ inputs.allow-reset-build-deps }}
Expand All @@ -135,19 +135,19 @@ jobs:
id: upload-artifact
with:
name: sdist-and-wheel
path: antsibull/build/ansible-*.*
path: antsibull-build/build/ansible-*.*

- name: Commit ansible-build-data and push the changes to github
working-directory: >-
antsibull/build/ansible-build-data/${{ steps.extract-version.outputs.major-version }}
antsibull-build/build/ansible-build-data/${{ steps.extract-version.outputs.major-version }}
run: |
git add .
git commit -m "${CI_COMMIT_MESSAGE}"
git push origin "${ANSIBLE_BRANCH_NAME}"
- name: Create PR to the ansible-build-data
id: create-pr
working-directory: antsibull/build/ansible-build-data
working-directory: antsibull-build/build/ansible-build-data
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
ARTIFACT_URL: ${{ steps.upload-artifact.outputs.artifact-url }}
Expand Down
16 changes: 8 additions & 8 deletions .github/workflows/antsibull-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,12 @@ jobs:
ansible_major_version: 11

steps:
- name: Check out antsibull
- name: Check out antsibull-build
uses: actions/checkout@v4
with:
repository: ansible-community/antsibull
repository: ansible-community/antsibull-build
ref: main
path: antsibull
path: antsibull-build

- name: Check out antsibull-core
uses: actions/checkout@v4
Expand Down Expand Up @@ -69,33 +69,33 @@ jobs:
path: antsibull-fileutils

- name: Pre-create build directory
run: mkdir -p antsibull/build
run: mkdir -p antsibull-build/build

# This is where the antsibull build-release role expects it by default
- name: Check out ansible-build-data under antsibull build directory
uses: actions/checkout@v4
with:
path: antsibull/build/ansible-build-data
path: antsibull-build/build/ansible-build-data

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

- name: Install dependencies
working-directory: antsibull
working-directory: antsibull-build
run: |
python3 -m pip install --upgrade pip
python3 -m pip install ansible-core . ../antsibull-core ../antsibull-changelog ../antsibull-docutils ../antsibull-fileutils
ansible-galaxy collection install 'git+https://github.com/ansible-collections/community.general.git'
- name: Lint collection metadata
working-directory: antsibull/build/ansible-build-data/${{ matrix.ansible_major_version }}
working-directory: antsibull-build/build/ansible-build-data/${{ matrix.ansible_major_version }}
run: |
antsibull-build lint-build-data ${{ matrix.ansible_major_version }}
- name: Test building a release with the defaults
working-directory: antsibull
working-directory: antsibull-build
run: |
ansible-playbook -vv playbooks/build-single-release.yaml \
-e antsibull_data_reset=false \
Expand Down
4 changes: 2 additions & 2 deletions docs/automated-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,11 +60,11 @@ release process. The automated processes uses GitHub Actions to automate the
branches down to the ansible-core version that is included in the Ansible
release.

5. Make sure that you have installed [`antsibull`](https://pypi.org/project/antsibull/)
5. Make sure that you have installed [`antsibull-build`](https://pypi.org/project/antsibull-build/)
and a supported clipboard library. You can do that like this:

```
pip install antsibull[clipboard]
pip install antsibull-build[clipboard]
```
6. Then announce the release on the Forum and Matrix by
Expand Down
2 changes: 1 addition & 1 deletion docs/policies.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ In case of violations, the release manager must preform the following steps:
[1]: https://github.com/ansible-collections/overview/blob/main/removal_from_ansible.rst
[2]: https://docs.ansible.com/ansible/devel/community/collection_contributors/collection_requirements.html#repository-management
[3]: https://github.com/ansible-community/antsibull/blob/main/playbooks/build-single-release.yaml
[3]: https://github.com/ansible-community/antsibull-build/blob/main/playbooks/build-single-release.yaml
[4]: https://github.com/ansible-community/ansible-build-data/blob/main/7/ansible-7.5.0-tags.yaml
[4a]: https://github.com/ansible-community/ansible-build-data/blob/main/7/validate-tags-ignores
[5]: https://docs.ansible.com/ansible/latest/collections/ansible/builtin/default_callback.html#parameter-result_format
22 changes: 11 additions & 11 deletions docs/release-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,18 +26,18 @@ podman run --name ansible-release -v ${PERSISTENT_DIRECTORY}:/pwd:z -w /pwd -ti

## Set up repository clones

First, you need to set up ansible-build-data and antsibull repository clones.
First, you need to set up ansible-build-data and antsibull-build repository clones.
This only needs to be done once.

1. [Fork][abd-fork] the [ansible-build-data] repository.

2. Checkout the antsibull and ansible-documentation repositories
and change into antsibull.
2. Checkout the antsibull-build and ansible-documentation repositories
and change into antsibull-build.

```
git clone https://github.com/ansible/ansible-documentation
git clone https://github.com/ansible-community/antsibull
cd antsibull
git clone https://github.com/ansible-community/antsibull-build
cd antsibull-build
```
3. Checkout ansible-build-data and configure your fork.
Expand All @@ -61,7 +61,7 @@ This only needs to be done once.
## Perform release process
1. Change into the antsibull checkout.
1. Change into the antsibull-build checkout.
Make sure you have the `main` branch checked out
and run `git pull` to update to the latest commit.
Expand All @@ -74,11 +74,11 @@ This only needs to be done once.
python3 -m pip install -U pip
```
Install the `antsibull`, `ansible-core`, and `twine` python packages,
Install the `antsibull-build`, `ansible-core`, and `twine` python packages,
as well as the community.general collection.
```
python3 -m pip install antsibull ansible-core twine
python3 -m pip install antsibull-build ansible-core twine
ansible-galaxy collection install --force community.general
```
Expand Down Expand Up @@ -128,7 +128,7 @@ This only needs to be done once.
6. Once the ansible-build-data PR has been merged,
publish the build artifacts to PyPI.
From the antsibull repository root, run
From the antsibull-build repository root, run
```
twine upload build/ansible-${VERSION}.tar.gz build/ansible-${VERSION}*.whl
Expand Down Expand Up @@ -162,6 +162,6 @@ This only needs to be done once.
[container]: https://hub.docker.com/_/python
[abd-fork]: https://github.com/ansible-community/ansible-build-data/fork
[ansible-build-data]: https://github.com/ansible-community/ansible-build-data
[release-playbook]: https://github.com/ansible-community/antsibull/blob/main/playbooks/build-single-release.yaml
[release-playbook-args]: https://github.com/ansible-community/antsibull/blob/main/roles/build-release/meta/argument_specs.yml
[release-playbook]: https://github.com/ansible-community/antsibull-build/blob/main/playbooks/build-single-release.yaml
[release-playbook-args]: https://github.com/ansible-community/antsibull-build/blob/main/roles/build-release/meta/argument_specs.yml
[tagging-enforcement]: https://github.com/gotmax23/ansible-build-data/blob/docs/docs/policies.md#enforcement

0 comments on commit ecb4239

Please sign in to comment.