Skip to content

Commit

Permalink
Fixed changes inconsistencies
Browse files Browse the repository at this point in the history 
Several changelog entries of the submitted package contains
bugzilla references which are not part of the git log.
Something that should never happen but well. This commit
updates the release tool to the latest version and adds
a new .changes and .changes.ref file within the inconsistencies
got fixed. In addition no longer existing e-mail addresses
will be replaced by their successor
  • Loading branch information
@schaefi
schaefi committed Jan 9, 2025
1 parent e3be7c8 commit a807d6a
Show file tree
Hide file tree
Showing 4 changed files with 4,419 additions and 1,150 deletions.
2 changes: 1 addition & 1 deletion Makefile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ build: check test
--since package/suse-migration-services.changes.ref --utc > \
dist/suse-migration-services.changes
helper/update_changelog.py \
--file package/suse-migration-services.changes >> \
--file package/suse-migration-services.changes --utc >> \
dist/suse-migration-services.changes
# update package version in spec file
cat package/suse-migration-services-spec-template \
Expand Down
174 changes: 89 additions & 85 deletions helper/update_changelog.py
View file
Original file line number Diff line number Diff line change
@@ -1,19 +1,22 @@
#!/usr/bin/python3
"""
usage: update_changelog (--since=<reference_file>|--file=<reference_file>)
[--from=<path>...]
[--utc]
[--fix]
arguments:
--since=<reference_file>
changes since the latest entry in the reference file
--from=<path>
changes which affected the given file or path
--file=<reference_file>
changes from the given file
--utc
print date/time in UTC
--fix
lookup .fix files and apply them
"""
import docopt
import os
import glob
import subprocess
import sys
from dateutil import parser
Expand Down Expand Up @@ -50,100 +53,101 @@
# Open reference log file
reference_file = arguments['--since'] or arguments['--file']

# Custom fix files
fix_dict = {}
if arguments['--fix']:
for fix in glob.iglob(f'{os.path.dirname(reference_file)}/*.fix'):
sys.stderr.write(f'Reading fix: {fix}{os.linesep}')
with open(fix, 'r') as fixlog:
commit = fixlog.readline()
fix_dict[commit] = fixlog.read()

if arguments['--since']:
# Read latest date from reference file
try:
with open(reference_file, 'r') as gitlog:
# read commit and author
gitlog.readline()
gitlog.readline()
# read date
latest_date = gitlog.readline().replace('AuthorDate:', '').strip()
date_reference = parser.parse(latest_date)
except Exception:
latest_date = None
with open(reference_file, 'r') as gitlog:
# read commit and author
gitlog.readline()
gitlog.readline()
# read date
latest_date = gitlog.readline().replace('AuthorDate:', '').strip()
date_reference = parser.parse(latest_date)

# Read git history since latest entry from reference file
git_arguments = [
'git', 'log'
]
git_arguments.append('--no-merges')
git_arguments.append('--format=fuller')
if latest_date:
git_arguments.append('--since="{0}"'.format(latest_date))
if arguments.get('--from'):
for source_repo in arguments.get('--from'):
git_arguments.append(source_repo)

process = subprocess.Popen(
git_arguments, stdout=subprocess.PIPE
[
'git', 'log', '--no-merges', '--format=fuller',
'--since="{0}"'.format(latest_date)
], stdout=subprocess.PIPE
)

from_git_log = True
for line in iter(process.stdout.readline, b''):
log_lines.append(line)
if line.startswith(b'commit'):
commit = line.decode()
if from_git_log and fix_dict.get(commit):
sys.stderr.write(f' Apply fix for: {commit}')
from_git_log = False
log_lines.append(line)
for fix_line in fix_dict.get(commit).split(os.linesep):
log_lines.append(fix_line.encode())
elif not from_git_log:
from_git_log = True

if from_git_log:
log_lines.append(line)
else:
with open(reference_file, 'rb') as gitlog:
log_lines = gitlog.readlines()

if arguments['--since']:
# append empty commit to prevent loosing log data if
# only one commit of change was found
log_lines.append(b'commit')
# Iterate over log data and convert to changelog format
for line_data in log_lines:
line = line_data.decode(encoding='utf-8')
if line.startswith('commit'):
if commit_message:
commit_message.pop(0)
message_header = commit_message.pop(0).lstrip()
message_body = []
for line in commit_message:
message_line = line.lstrip()
if not message_line:
message_body.append(os.linesep)
else:
message_body.append(
' {0}{1}'.format(message_line, os.linesep)
)
log_data[log_date] = ''.join(
[
log_start,
'{0} - {1}{2}{2}'.format(
log_date.astimezone(
tz.UTC if arguments['--utc'] else tz.tzlocal()
).strftime(date_format), log_author, os.linesep
),
'- {0}{1}'.format(
message_header, os.linesep
)
] + message_body
)
commit_message = []
elif line.startswith('Author:'):
log_author = line.replace('Author:', '').strip()
elif line.startswith('AuthorDate:'):
log_date = parser.parse(line.replace('AuthorDate:', '').strip())
elif line.startswith('Commit:'):
pass
elif line.startswith('CommitDate:'):
pass
else:
commit_message.append(line.strip())

# print in changelog format on stdout
for author_date in reversed(sorted(log_data.keys())):
if date_reference:
if date_reference < author_date:
sys.stdout.write(log_data[author_date])
else:
skip_list.append(author_date)
else:
# Iterate over log data and convert to changelog format
for line_data in log_lines:
line = line_data.decode(encoding='utf-8')
if line.startswith('commit'):
if commit_message:
commit_message.pop(0)
message_header = commit_message.pop(0).lstrip()
message_body = []
for line in commit_message:
message_line = line.lstrip()
if not message_line:
message_body.append(os.linesep)
else:
message_body.append(
' {0}{1}'.format(message_line, os.linesep)
)
log_data[log_date] = ''.join(
[
log_start,
'{0} - {1}{2}{2}'.format(
log_date.astimezone(
tz.UTC if arguments['--utc'] else tz.tzlocal()
).strftime(date_format), log_author, os.linesep
),
'- {0}{1}'.format(
message_header, os.linesep
)
] + message_body
)
commit_message = []
elif line.startswith('Author:'):
log_author = line.replace('Author:', '').strip()
elif line.startswith('AuthorDate:'):
log_date = parser.parse(line.replace('AuthorDate:', '').strip())
elif line.startswith('Commit:'):
pass
elif line.startswith('CommitDate:'):
pass
else:
commit_message.append(line.strip())

# print in changelog format on stdout
for author_date in reversed(sorted(log_data.keys())):
if date_reference:
if date_reference < author_date:
sys.stdout.write(log_data[author_date])
sys.stdout.write(os.linesep)
else:
for line_data in log_lines:
line = line_data.decode(encoding='utf-8')
sys.stdout.write(line)
else:
skip_list.append(author_date)
else:
sys.stdout.write(log_data[author_date])

# print inconsistencies if any on stderr
if skip_list:
Expand Down
Loading

0 comments on commit a807d6a

Please sign in to comment.