MokoConsulting/MokoCassiopeia
1
1
Fork 0
Code Issues 4 Pull Requests Actions Packages Releases 1 Activity

Add date normalization script for release pipeline #40

Merged
Copilot merged 5 commits from copilot/add-date-normalization-script into main 2026-01-09 01:27:22 +00:00
Conversation 2 Commits 5 Files Changed 1 +77
1 changed files with 77 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

77
scripts/release/update_dates.sh Executable file
View File

@@ -0,0 +1,77 @@
#!/usr/bin/env bash
# Copyright (C) 2025 Moko Consulting <hello@mokoconsulting.tech>
#
# This file is part of a Moko Consulting project.
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see https://www.gnu.org/licenses/ .
#
# FILE INFORMATION
# DEFGROUP: Release
# INGROUP: Moko-Cassiopeia
# PATH: scripts/release/update_dates.sh
# VERSION: 03.05.00
# BRIEF: Normalize dates in release files
set -euo pipefail
# Accept date and version as arguments
TODAY="${1:-$(date +%Y-%m-%d)}"
VERSION="${2:-unknown}"
copilot-pull-request-reviewer[bot] commented 2026-01-09 01:34:16 +00:00 (Migrated from github.com)
Review
Copy Link

The VERSION parameter defaults to "unknown" but lacks validation when explicitly provided. If an empty string or whitespace-only value is passed as the second argument, it could lead to incorrect sed patterns that match unintended lines. Consider adding validation to ensure VERSION is not empty and contains expected characters, similar to the date validation on line 35.

The VERSION parameter defaults to "unknown" but lacks validation when explicitly provided. If an empty string or whitespace-only value is passed as the second argument, it could lead to incorrect sed patterns that match unintended lines. Consider adding validation to ensure VERSION is not empty and contains expected characters, similar to the date validation on line 35.
# Validate date format (YYYY-MM-DD)
if ! [[ "${TODAY}" =~ ^[0-9]{4}-[0-9]{2}-[0-9]{2}$ ]]; then
echo "ERROR: Invalid date format '${TODAY}'. Expected YYYY-MM-DD format."
exit 1
fi
echo "Date normalization script running..."
echo "TODAY: ${TODAY}"
echo "VERSION: ${VERSION}"
# Escape special regex characters in VERSION for safe use in grep and sed
# Escapes: ] \ / $ * . ^ [
VERSION_ESCAPED=$(printf '%s\n' "${VERSION}" | sed 's/[][\/$*.^]/\\&/g')
# Update CHANGELOG.md - replace the date on the version heading line
if [ -f "CHANGELOG.md" ]; then
# Match lines like "## [03.05.00] 2026-01-04" and update the date
if grep -q "^## \[${VERSION_ESCAPED}\] " CHANGELOG.md; then
sed -i "s/^## \[${VERSION_ESCAPED}\] [0-9]\{4\}-[0-9]\{2\}-[0-9]\{2\}/## [${VERSION_ESCAPED}] ${TODAY}/" CHANGELOG.md
echo "✓ Updated CHANGELOG.md version [${VERSION}] date to ${TODAY}"
else
echo "⚠ Warning: CHANGELOG.md does not contain version [${VERSION}] heading"
fi
else
echo "⚠ Warning: CHANGELOG.md not found"
fi
# Update src/templates/templateDetails.xml - replace the <creationDate> tag
if [ -f "src/templates/templateDetails.xml" ]; then
sed -i "s|<creationDate>[0-9]\{4\}-[0-9]\{2\}-[0-9]\{2\}</creationDate>|<creationDate>${TODAY}</creationDate>|" src/templates/templateDetails.xml
echo "✓ Updated src/templates/templateDetails.xml creationDate to ${TODAY}"
else
echo "⚠ Warning: src/templates/templateDetails.xml not found"
fi
# Update updates.xml - replace the <creationDate> tag
if [ -f "updates.xml" ]; then
sed -i "s|<creationDate>[0-9]\{4\}-[0-9]\{2\}-[0-9]\{2\}</creationDate>|<creationDate>${TODAY}</creationDate>|" updates.xml
copilot-pull-request-reviewer[bot] commented 2026-01-09 01:34:16 +00:00 (Migrated from github.com)
Review
Copy Link

The sed commands on lines 63 and 71 will replace ALL occurrences of the creationDate pattern in the respective XML files. While currently each file has only one creationDate tag, this approach is fragile. If the XML files evolve to include multiple update entries (e.g., update history), all creationDate tags would be incorrectly updated to the same date. Consider making the replacement more specific by including more context in the pattern, such as matching within a specific version tag or using a more targeted XML-aware approach.

The sed commands on lines 63 and 71 will replace ALL occurrences of the creationDate pattern in the respective XML files. While currently each file has only one creationDate tag, this approach is fragile. If the XML files evolve to include multiple update entries (e.g., update history), all creationDate tags would be incorrectly updated to the same date. Consider making the replacement more specific by including more context in the pattern, such as matching within a specific version tag or using a more targeted XML-aware approach.
echo "✓ Updated updates.xml creationDate to ${TODAY}"
else
echo "⚠ Warning: updates.xml not found"
fi
echo "Date normalization complete."