From 6b18b5d027c394c440db3d7def9e350653a99858 Mon Sep 17 00:00:00 2001 From: pulpbot Date: Sun, 13 Oct 2024 17:33:14 +0000 Subject: [PATCH] Update CI files --- .github/template_gitref | 2 +- .github/workflows/scripts/script.sh | 10 ++++++---- MANIFEST.in | 1 + releasing.md | 27 +++++++++++++++++++++++++++ 4 files changed, 35 insertions(+), 5 deletions(-) create mode 100644 releasing.md diff --git a/.github/template_gitref b/.github/template_gitref index a743dd7f9f..4fb36e9605 100644 --- a/.github/template_gitref +++ b/.github/template_gitref @@ -1 +1 @@ -2021.08.26-385-g17472a1 +2021.08.26-387-ge627e91 diff --git a/.github/workflows/scripts/script.sh b/.github/workflows/scripts/script.sh index ee9d25abd7..7f5c2b1a04 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=" core " + else + BUILT_CLIENTS="" fi for ITEM in $(jq -r '.versions[] | tojson' <<<"${REPORTED_STATUS}") diff --git a/MANIFEST.in b/MANIFEST.in index 475464519e..2004bd201b 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -13,3 +13,4 @@ include COPYRIGHT include pulpcore/app/templates/rest_framework/api.html include manage.py include test_requirements.txt +exclude releasing.md diff --git a/releasing.md b/releasing.md new file mode 100644 index 0000000000..b1d93e889d --- /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 pulpcore' 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/pulpcore/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/pulpcore/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/).