From c18b1387faed84de2ef07edf2f051831e93fbedb Mon Sep 17 00:00:00 2001 From: pulpbot Date: Sun, 13 Oct 2024 14:35:04 +0000 Subject: [PATCH] Update CI files --- .ci/assets/ci_constraints.txt | 2 +- .ci/scripts/check_release.py | 11 ++++++++--- .ci/scripts/pr_labels.py | 2 +- .github/template_gitref | 2 +- .github/workflows/scripts/script.sh | 10 ++++++---- MANIFEST.in | 1 + releasing.md | 27 +++++++++++++++++++++++++++ 7 files changed, 45 insertions(+), 10 deletions(-) create mode 100644 releasing.md diff --git a/.ci/assets/ci_constraints.txt b/.ci/assets/ci_constraints.txt index c4589f7ca..14b515968 100644 --- a/.ci/assets/ci_constraints.txt +++ b/.ci/assets/ci_constraints.txt @@ -9,4 +9,4 @@ tablib!=3.6.0 # Newer version seem to have a conflict around packaging, that pip fails to resolve in time. Remove this when this starts to impose an issue. -pipdeptree<=2.23.1 +pipdeptree<=3.23.1 diff --git a/.ci/scripts/check_release.py b/.ci/scripts/check_release.py index 496ac29da..c0dbf3aba 100755 --- a/.ci/scripts/check_release.py +++ b/.ci/scripts/check_release.py @@ -64,6 +64,7 @@ def main(): for branch in branches: if branch != DEFAULT_BRANCH: # Check if a Z release is needed + reasons = [] changes = repo.git.ls_tree("-r", "--name-only", f"origin/{branch}", "CHANGES/") z_changelog = False for change in changes.split("\n"): @@ -76,23 +77,27 @@ def main(): ) elif ext in Z_CHANGELOG_EXTS: z_changelog = True + if z_changelog: + reasons.append("Backports") last_tag = repo.git.describe("--tags", "--abbrev=0", f"origin/{branch}") req_txt_diff = repo.git.diff( f"{last_tag}", f"origin/{branch}", "--name-only", "--", "requirements.txt" ) - if z_changelog or req_txt_diff: + if req_txt_diff: + reasons.append("requirements.txt") + + if reasons: curr_version = Version(last_tag) assert curr_version.base_version.startswith( branch ), "Current-version has to belong to the current branch!" next_version = Version(f"{branch}.{curr_version.micro + 1}") - reason = "CHANGES" if z_changelog else "requirements.txt" print( f"A Z-release is needed for {branch}, " f"Prev: {last_tag}, " f"Next: {next_version.base_version}, " - f"Reason: {reason}" + f"Reason: {','.join(reasons)}" ) releases.append(next_version) else: diff --git a/.ci/scripts/pr_labels.py b/.ci/scripts/pr_labels.py index 24edc7324..0c478a212 100755 --- a/.ci/scripts/pr_labels.py +++ b/.ci/scripts/pr_labels.py @@ -23,7 +23,7 @@ def main(): f".{item['directory']}" for item in PYPROJECT_TOML["tool"]["towncrier"]["type"] } except KeyError: - CHANGELOG_EXTS = {"feature", "bugfix", "doc", "removal", "misc"} + CHANGELOG_EXTS = {".feature", ".bugfix", ".doc", ".removal", ".misc"} repo = Repo(".") diff --git a/.github/template_gitref b/.github/template_gitref index e7ed8764b..4fb36e960 100644 --- a/.github/template_gitref +++ b/.github/template_gitref @@ -1 +1 @@ -2021.08.26-383-gca51ecf +2021.08.26-387-ge627e91 diff --git a/.github/workflows/scripts/script.sh b/.github/workflows/scripts/script.sh index b7ce124d8..9c4c189c5 100755 --- a/.github/workflows/scripts/script.sh +++ b/.github/workflows/scripts/script.sh @@ -46,12 +46,14 @@ pushd ../pulp-openapi-generator # Workaround: Domains are not supported by the published bindings. # Sadly: Different pulpcore-versions aren't either... - # So we exclude the prebuilt ones only for domains disabled. - if [ "$(jq -r '.domain_enabled' <<<"${REPORTED_STATUS}")" = "true" ] || [ "$(jq -r '.online_workers[0].pulp_href|startswith("/pulp/api/v3/")' <<< "${REPORTED_STATUS}")" = "false" ] + # * In the 'pulp' scenario we use the published/prebuilt bindings, so we can test it. + # * In other scenarios we generate new bindings from server spec, so we have a more + # reliable client. + if [ "$TEST" = "pulp" ] then - BUILT_CLIENTS="" - else BUILT_CLIENTS=" ansible " + else + BUILT_CLIENTS="" fi for ITEM in $(jq -r '.versions[] | tojson' <<<"${REPORTED_STATUS}") diff --git a/MANIFEST.in b/MANIFEST.in index 836e90d27..29d1086fc 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -10,3 +10,4 @@ include test_requirements.txt include unittest_requirements.txt include pyproject.toml include pulp_ansible/app/schema/* +exclude releasing.md diff --git a/releasing.md b/releasing.md new file mode 100644 index 000000000..bceac800f --- /dev/null +++ b/releasing.md @@ -0,0 +1,27 @@ +[//]: # "WARNING: DO NOT EDIT!" +[//]: # "" +[//]: # "This file was generated by plugin_template, and is managed by it. Please use" +[//]: # "'./plugin-template --github pulp_ansible' to update this file." +[//]: # "" +[//]: # "For more info visit https://github.com/pulp/plugin_template" +# Releasing (For Internal Use) + +This document outlines the steps to perform a release. + +### Determine if a Release is Required +- Run the release checker script: + ``` + python3 .ci/scripts/check_release.py + ``` + +### Create a New Y-branch (e.g., 3.23) +- If a new minor version (Y) is needed, trigger a [Create New Release Branch](https://github.com/pulp/pulp_ansible/actions/workflows/create-branch.yml) job via the GitHub Actions. +- Look for the "Bump minor version" pull request and merge it. + +### Release a New Z-version (Patch Release) (e.g., 3.23.1, 3.22.12) +- Trigger a [Release Pipeline](https://github.com/pulp/pulp_ansible/actions/workflows/release.yml) job by specifying the release branch (X.Y) via the GitHub Actions. + +### Final Steps (Optional but Recommended) +- Ensure the new version appears on PyPI. +- Verify that the changelog has been updated by looking for the "Update Changelog" pull request. +- Post a brief announcement about the new release on the [Pulp Discourse](https://discourse.pulpproject.org/).