Skip to content

CI: Drop USN descriptions from release when too big #720

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.

Sign up for GitHub

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

Merged
selzoc merged 1 commit into from
Aug 31, 2026
Merged

CI: Drop USN descriptions from release when too big #720

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
49 changes: 35 additions & 14 deletions ci/tasks/build-release-metadata.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,36 +16,54 @@ mkdir -p "${REPO_PARENT}/release-metadata"
echo -n "${OS_NAME} ${OS_VERSION} v$version" > "${REPO_PARENT}/release-metadata/name"
echo -n "${OS_NAME}-${OS_VERSION}/v$version" > "${REPO_PARENT}/release-metadata/tag"

body_file="${REPO_PARENT}/release-metadata/body"
usn_log_json_file="${REPO_PARENT}/bosh-linux-stemcell-builder/usn-log.json"

format_usn_log() {
local usn_data=${1}
local include_description=${2}

jq -r --slurp < "${usn_data}" '.[] |
jq -r --slurp --argjson desc "${include_description}" < "${usn_data}" '.[] |
"
**Title**: " + .title +"
**URL**: " + .url +"
**Priorities**: " + (.priorities | join(",")) +"
**Priorities**: " + (.priorities | join(",")) +
(if $desc then "
**Description**:
" + .description +"
" + .description else "" end) +"
**CVEs**:
" + (.cves | map(" - " + .) | join("\n"))
'
}

write_body() {
local include_description=${1}

{
echo "## Metadata:"
echo "**BOSH Agent Version**: ${bosh_agent_version}"
echo "**Kernel Version**: ${kernel_version}"

if [[ "${OS_NAME}" == "ubuntu" ]]; then
echo ""
echo "## USNs:"
if [[ "${include_description}" != "true" ]]; then
echo "_USN descriptions omitted, see the USN URLs below for details._"
fi
format_usn_log "${usn_log_json_file}" "${include_description}"
fi
} > "${body_file}"
}

pushd "${REPO_PARENT}/candidate-stemcell"
tar xvf bosh-stemcell-*-warden-boshlite-"${OS_NAME}"-"${OS_VERSION}"*.tgz packages.txt
kernel_version=$(grep "${KERNEL_PACKAGE}" packages.txt | awk '{print $3}')
popd

bosh_agent_version=$(cat "${REPO_PARENT}/bosh-linux-stemcell-builder/stemcell_builder/stages/bosh_go_agent/assets/bosh-agent-version")
{
echo "## Metadata:"
echo "**BOSH Agent Version**: ${bosh_agent_version}"
echo "**Kernel Version**: ${kernel_version}"
} >> "${REPO_PARENT}/release-metadata/body"

if [[ "${OS_NAME}" == "ubuntu" ]]; then
# Ensure URL for usn-log from metalink exists before attempting to download.
usn_log_json_file="${REPO_PARENT}/bosh-linux-stemcell-builder/usn-log.json"
touch "${usn_log_json_file}"
usn_metalink_path="${REPO_PARENT}/bosh-linux-stemcell-builder/image-metalinks/${BRANCH}/${OS_NAME}-${OS_VERSION}.meta4"
if [[ -n "$(meta4 file-urls --metalink "${usn_metalink_path}" --file usn-log.json)" ]]; then
Expand All @@ -56,12 +74,15 @@ if [[ "${OS_NAME}" == "ubuntu" ]]; then
--file usn-log.json \
"${usn_log_json_file}"
fi
fi

{
echo ""
echo "## USNs:"
format_usn_log "${usn_log_json_file}"
} >> "${REPO_PARENT}/release-metadata/body"
write_body true

# GitHub rejects release bodies over 125,000 characters. wc -c counts bytes, which
# is >= the character count for UTF-8, so this guard fires early, never late.
MAX_BODY_LEN=120000
if [[ $(wc -c < "${body_file}") -gt ${MAX_BODY_LEN} ]]; then
write_body false
Comment thread
selzoc marked this conversation as resolved.
fi

echo "" > "${REPO_PARENT}/usn-log/usn-log.json"
Loading