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.

Sign up for GitHub

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

Jump to bottom

♻️ Refactor Get-ReleaseDescription.ps1 to Improve Modularity and Add Enhanced Release Description Functionality #2291

Merged
merged 2 commits into from
Aug 14, 2024
Merged

♻️ Refactor Get-ReleaseDescription.ps1 to Improve Modularity and Add Enhanced Release Description Functionality #2291

merged 2 commits into from
Aug 14, 2024

Commits on Aug 14, 2024

  1. ♻️ (Get-ReleaseDescription.ps1): refactor to use Get-GitChanges funct… 

    …ion for better modularity

Refactor the script to replace inline git operations with a call to the Get-GitChanges function. This improves code modularity and readability, making it easier to maintain and extend in the future. The new function encapsulates the logic for fetching git changes based on the specified mode, reducing redundancy and potential errors.

✨ (Get-ReleaseDescription.ps1): add new function Get-ReleaseDescription2 for enhanced release descriptions
♻️ (Get-ReleaseDescription.ps1): refactor existing functions to improve modularity and readability
🔧 (Get-ReleaseDescription.ps1): add new configuration options for OpenAI API integration

Introduce a new function `Get-ReleaseDescription2` to generate detailed release descriptions using OpenAI's API. Refactor existing code to improve modularity, making it easier to maintain and extend. Add new configuration options to support different modes and environment variables, enhancing the script's flexibility and usability.

🔧 (Get-ReleaseDescription.ps1): switch from Write-Host to Write-Debug for better logging
The change replaces `Write-Host` with `Write-Debug` to improve logging practices. Using `Write-Debug` allows for more controlled and conditional output, which is useful for debugging without cluttering standard output. Additionally, the elapsed time for the operation is now logged, providing better insights into performance.

✨ (build): add test.ps1 script for generating release descriptions
📝 (docs): update MigrationTools.xml with new Git metadata

Add a new PowerShell script `test.ps1` to the build process to generate release descriptions using the `Get-ReleaseDescription2` function. This script helps automate the release note generation, improving the release workflow.

Update `MigrationTools.xml` to reflect the latest Git metadata, including commit hashes, commit dates, and version tags. This ensures that the documentation is up-to-date with the current state of the repository.
    @MrHinsh
    MrHinsh committed Aug 14, 2024
    Configuration menu
    Copy the full SHA
    ff187d2 View commit details
    Browse the repository at this point in the history

  2. ✨ (Get-ReleaseDescription.ps1): add Get-PullRequestData function to g… 

    …enerate PR descriptions using OpenAI

🔧 (Get-ReleaseDescription.ps1): update documentation globs to exclude generated reference files
🔧 (test.ps1): update test script to use Get-PullRequestData for generating descriptions

The new `Get-PullRequestData` function leverages OpenAI to generate detailed pull request descriptions, improving the quality and consistency of PR documentation. The documentation globs are updated to exclude generated reference files, ensuring cleaner documentation. The test script is updated to use the new function, enhancing the testing process.
    @MrHinsh
    MrHinsh committed Aug 14, 2024
    Configuration menu
    Copy the full SHA
    9d0adfb View commit details
    Browse the repository at this point in the history