ci: Add scripts for generating changelog and version

[uristdwarf]

No description provided.

[gemini-code-assist]

Hello @uristdwarf, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

Summary of Changes

This pull request introduces scripts to automate the generation of changelogs and version updates. It includes scripts for extracting changelog entries from git logs, determining the next version number based on commit types (feat, fix, breaking change), and updating the CMakeLists.txt and NEWS files accordingly. The goal is to streamline the release process by automating these tasks.

Highlights

• Changelog Generation: The ci/get-changelog.sh script extracts commit messages from the git log between two specified references (defaults to stable and HEAD).
• Version Bumping: The ci/new-version.sh script determines the next version number by analyzing commit types (feat, fix, breaking change) and updates the version components accordingly. It reads the current version from CMakeLists.txt.
• CMakeLists Update: The ci/update-cmake.sh script updates the DEFAULT_MIN_VERSION variable in CMakeLists.txt with the new version generated by ci/new-version.sh.
• NEWS File Update: The ci/update-news.sh script generates a new entry for the NEWS file, including the version number and a list of changes extracted from the git log, excluding chore, style, refactor, test, Merge, and ci commits.

Changelog

Click here to see the changelog

• ci/get-changelog.sh
  • New file created to extract changelog entries from git logs.
  • Uses git log to retrieve commit messages between two references.
• ci/new-version.sh
  • New file created to determine the next version number based on commit types.
  • Parses commit messages to identify features, fixes, and breaking changes.
  • Reads the current version from CMakeLists.txt.
  • Calculates the new version number based on the identified changes.
• ci/update-cmake.sh
  • New file created to update the DEFAULT_MIN_VERSION variable in CMakeLists.txt.
  • Uses sed to replace the existing version with the new version.
• ci/update-news.sh
  • New file created to generate a new entry for the NEWS file.
  • Extracts changelog entries using ci/get-changelog.sh.
  • Formats the changelog entries and inserts them into the NEWS file after the first line.
  • Excludes chore, style, refactor, test, Merge, and ci commits from the changelog.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

---

A version's tale, in scripts entwined,
From commit logs, the future defined.
With feats and fixes, a version's grace,
Automated steps, in time and space.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

The pull request introduces scripts for generating changelogs and managing version updates. The scripts seem functional, but there are areas where clarity and robustness can be improved. Specifically, the new-version.sh script could benefit from more explicit error handling and better handling of edge cases in version bumping logic. The update-news.sh script could be improved by using a more robust method for inserting the new NEWS entry.

Summary of Findings

• Error Handling in new-version.sh: The new-version.sh script lacks explicit error handling for cases where version bumping logic fails (e.g., no relevant commits found). Adding checks and informative error messages would improve the script's reliability.
• Robustness of NEWS Entry Insertion: The update-news.sh script uses a simple method for inserting the new NEWS entry, which might be fragile. Using sed or awk for more precise insertion could improve robustness.
• Clarity of Commit Type Extraction: The commit type extraction in new-version.sh could be made more readable by using more descriptive variable names and simplifying the sed command.

Merge Readiness

The pull request is functional but requires improvements in error handling, robustness, and code clarity. Addressing the issues identified in the review comments would significantly enhance the quality and reliability of the scripts. I am unable to approve this pull request, and recommend that it not be merged until these issues are addressed.

[rolysr]

LGTM