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

feat: [DevOps] Release notes automation #390

Merged
merged 10 commits into from
Mar 19, 2025
Prev Previous commit
Next Next commit
fix release_notes_automation.py
CharlesDuboisSAP committed Mar 18, 2025
commit 5467421ca6e64d34a80b99922bb1d92b4d314f15
14 changes: 4 additions & 10 deletions .pipeline/scripts/release_notes_automation.py
Original file line number Diff line number Diff line change
@@ -72,10 +72,10 @@ def count_releases(filename):
return count

def find_target_file(version):
# release-notes-X-to-Y.md with every 15 versions the index increases by 15 and stays the same for 15 versions
# release-notes-X-to-Y.mdx with every 15 versions the index increases by 15 and stays the same for 15 versions
minor_version = int(version.split(".")[1])
index = minor_version // 15 * 15
return "release-notes-" + str(index) + "-to-" + str(index + 14) + ".md"
return "release-notes-" + str(index) + "-to-" + str(index + 14) + ".mdx"

def write_release_notes(folder, target_file):
absolute_target_file = os.path.join(folder, target_file)
@@ -95,7 +95,7 @@ def write_release_notes(folder, target_file):
parser = argparse.ArgumentParser(description='SAP Cloud SDK for AI (for Java) - Release Notes formatting script.')

parser.add_argument('--version', metavar='VERSION', help='The version to be released.', required=True)
parser.add_argument('--folder', metavar='FOLDER', help='The ai-sdk-java/docs/release-notes folder.', required=True)
parser.add_argument('--folder', metavar='FOLDER', help='The ai-sdk/docs-java/release-notes folder.', required=True)
args = parser.parse_args()

file = read_file(file_name)
@@ -105,10 +105,4 @@ def write_release_notes(folder, target_file):
file = direct_links(file)

target_file = find_target_file(args.version)


folder_path = args.folder
write_release_notes(folder_path, target_file)

# delete (temporary) release-notes file so it does not appear in the released version
os.remove(file_name)
write_release_notes(args.folder, target_file)