Source code
Revision control
Copy as Markdown
Other Tools
#!/usr/bin/env python3
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
"""
Generate NSS release email text based on version number.
Usage: python3 generate_release_email.py <version> <previous_version> [output_file]
Example:
python3 generate_release_email.py 3.118 3.117
python3 generate_release_email.py 3.118.1 3.118 release_email_3.118.1.txt
"""
import os
import re
import sys
from datetime import datetime
from subprocess import check_output
def exit_with_failure(message):
"""Exit the script with an error message."""
print(f"ERROR: {message}", file=sys.stderr)
sys.exit(1)
def version_string_to_underscore(version_string):
"""Convert version string like '3.118' to '3_118'."""
return version_string.replace('.', '_')
def version_string_to_RTM_tag(version_string):
"""Convert version string like '3.118' to 'NSS_3_118_RTM'."""
parts = version_string.split('.')
return "NSS_" + "_".join(parts) + "_RTM"
def get_nspr_version():
"""Read the NSPR version from automation/release/nspr-version.txt."""
nspr_version_file = "automation/release/nspr-version.txt"
try:
with open(nspr_version_file, 'r') as f:
return f.readline().strip()
except FileNotFoundError:
exit_with_failure(f"Could not find {nspr_version_file}. Are you running from the NSS root directory?")
def get_changes_from_hg(current_tag, previous_tag):
"""Extract bug changes from Mercurial log between two tags."""
try:
# Get log entries between previous tag and current tag
command = ["hg", "log", "-r", f"{previous_tag}:{current_tag}", "--template", "{desc|firstline}\\n"]
log_output = check_output(command).decode('utf-8')
except Exception as e:
exit_with_failure(f"Failed to get hg log: {e}")
# Extract bug numbers and descriptions
bug_lines = []
for line in reversed(log_output.split('\n')):
if 'Bug' in line or 'bug' in line:
line = line.strip()
# Remove reviewer information
line = line.split("r=")[0].strip()
line = re.sub(r'(Bug\s+\d+)\s+([^-])', r'\1 - \2', line, flags=re.IGNORECASE)
# Clean up punctuation
if line:
line = line.rstrip(',')
# Add a full stop at the end if there isn't one
if line and not line.endswith('.'):
line = line + '.'
if line and line not in bug_lines:
bug_lines.append(line)
return bug_lines
def generate_email_content(version, nspr_version, bug_lines, release_date):
"""Generate the email content for the release announcement."""
version_underscore = version_string_to_underscore(version)
changes_text = "\n\n".join([f" {line}" for line in bug_lines])
email_content = f"""Network Security Services (NSS) {version} was released on {release_date}.
The HG tag is NSS_{version_underscore}_RTM. This version of NSS requires NSPR {nspr_version} or newer. The latest version of NSPR is {nspr_version}.
NSS {version} source distributions are available on ftp.mozilla.org for secure HTTPS download:
Changes:
{changes_text}
NSS {version} shared libraries are backwards-compatible with all older NSS 3.x shared libraries. A program linked with older NSS 3.x shared libraries will work with this new version of the shared libraries without recompiling or relinking. Furthermore, applications that restrict their use of NSS APIs to the functions listed in NSS Public Functions will remain compatible with future versions of the NSS shared libraries.
Bugs discovered should be reported by filing a bug report at <https://bugzilla.mozilla.org/enter_bug.cgi?product=NSS>
Release notes are available at <https://firefox-source-docs.mozilla.org/security/nss/releases/index.html>.
"""
return email_content
def main():
if len(sys.argv) < 3:
print(__doc__)
sys.exit(1)
version = sys.argv[1].strip()
previous_version = sys.argv[2].strip()
# Determine output file (optional)
output_file = None
if len(sys.argv) >= 4:
output_file = sys.argv[3].strip()
# Get current date
current_date = datetime.now().strftime("%-d %B %Y")
# Get NSPR version
nspr_version = get_nspr_version()
# Convert versions to tags
current_tag = version_string_to_RTM_tag(version)
previous_tag = version_string_to_RTM_tag(previous_version)
print(f"Generating release email for NSS {version}")
print(f"Previous version: {previous_version}")
print(f"Current tag: {current_tag}")
print(f"Previous tag: {previous_tag}")
print(f"NSPR version: {nspr_version}")
print(f"Release date: {current_date}")
print()
# Get changes from Mercurial
print("Extracting changes from Mercurial...")
bug_lines = get_changes_from_hg(current_tag, previous_tag)
print(f"Found {len(bug_lines)} bug entries")
print()
# Generate email content
email_content = generate_email_content(version, nspr_version, bug_lines, current_date)
# Write to file if specified, otherwise print to stdout
if output_file:
with open(output_file, 'w') as f:
f.write(email_content)
print(f"Release email written to: {output_file}")
print()
print("=" * 70)
print("Email Content:")
print("=" * 70)
print(email_content)
if __name__ == "__main__":
main()