Skip to content
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.

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

[SL-ONLY] First version of the script to parse git branches for our commits TAG #88

Merged
merged 3 commits into from
Nov 20, 2024
Merged
Changes from 2 commits
Commits
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
68 changes: 68 additions & 0 deletions scripts/tools/silabs/retrieve_sl_commits.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
#! /usr/bin/python3
import subprocess
import argparse
from argparse import RawTextHelpFormatter

def get_git_log(start_sha, end_sha, prefixes):
try:
# Run the git log command with output format <Commit short hash> | <Author> | <Title>
result = subprocess.run(
['git', 'log', '--pretty=format:%h | %an | %s %s', f'{start_sha}..{end_sha}'],
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
check=True,
text=True
)

# Split the result into lines
log_lines = result.stdout.split('\n')
jmartinez-silabs marked this conversation as resolved.
Show resolved Hide resolved

# Initialize a dictionary to hold commits by prefix
commits_by_prefix = {prefix: [] for prefix in prefixes}

# Filter and group commits based on the prefixes
for line in log_lines:
for prefix in prefixes:
if prefix in line:
commits_by_prefix[prefix].append(line)
break

return commits_by_prefix

except subprocess.CalledProcessError as e:
print(f"Error running git log: {e}")
return {}

def main():
parser = argparse.ArgumentParser(formatter_class=RawTextHelpFormatter, description="""
This script will parse git logs for our silabs prefixes ([SL-UP], [SL-TEMP], [SL-ONLY] or [CSA-CP]) between the commit SHAs provided in parameters
on the current git branch.
It will then output, per prefix, the commit sha and commit Title in the following format)
[PREFIX] commits:
<full_commit_sha> -- <Commit_Title>
""",
epilog= """
Post result developer actions:
commits grouped under [SL-UP] shall be upstream the CSA master.
commits grouped under [SL-ONLY] shall be cherry-picked to matter_sdk main branch.
commits grouped under [SL-TEMP] must be revised. Are they still required, are they needed on main or for the next release. If they are, they need to be cherry-picked.
commits grouped under [CSA-CP] are purely informative. They already exist in CSA master and will automatically be brought to main or the new release branch through CSA master merges.
""")
parser.add_argument('start_sha', type=str, help='The starting commit SHA')
parser.add_argument('end_sha', type=str, help='The ending commit SHA')

args = parser.parse_args()

start_sha = args.start_sha
end_sha = args.end_sha
prefixes = ["[SL-UP]", "[SL-TEMP]", "[SL-ONLY]", "[CSA-CP]"]

commits_by_prefix = get_git_log(start_sha, end_sha, prefixes)
for prefix, commits in commits_by_prefix.items():
print(f"{prefix} commits:")
for commit in commits:
print(commit)
print()

if __name__ == "__main__":
main()
Loading