Build/better release description #2256
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add a PowerShell script to generate release descriptions using OpenAI's API. This script fetches commit logs or diffs, formats them, and sends them to the API for generating structured release notes. The generated description is then included in the GitHub Actions workflow for releases. Automating the generation of release descriptions ensures consistency and saves time, while leveraging AI helps in creating comprehensive and well-structured release notes.
…s of nkdAgility_Ring value The condition for running the steps is simplified to always run if the previous steps are successful. The previous condition checking for `nkdAgility_Ring != 'Canary'` is commented out, likely to ensure the steps run in all environments for broader testing or deployment purposes.
github-actions
bot
added
build-action
The path separator is corrected from Unix-style (`./`) to Windows-style (`.\`) to ensure compatibility with PowerShell on Windows runners. This change is necessary to avoid script execution errors in the GitHub Actions workflow.
…ools-Scripts Include steps to upload and download the AzureDevOpsMigrationTools-Scripts artifact in the GitHub Actions workflow. This ensures that the scripts are properly archived and available for subsequent jobs, improving the workflow's robustness and reliability.
…workflow Adding the `path: ./build/` parameter to the `actions/download-artifact@v4` step ensures that the downloaded artifact is placed in the `./build/` directory. This change improves the organization of the workflow by clearly defining where artifacts should be stored, making it easier to manage and locate them during subsequent steps.
…ad steps Add `nkdAgility_ReleaseDescription` to capture release descriptions using the OpenAI API. Adjust artifact upload steps to ensure scripts are uploaded only once, improving workflow efficiency. This change enhances the release process by including detailed descriptions and optimizes the workflow by removing redundant steps.
…nt variables Include nkdAgility_ReleaseDescription in the workflow to pass the release description output from the Setup job. This ensures that the release description is available for subsequent steps, improving the workflow's ability to handle release metadata.
♻️ (Get-ReleaseDescription.ps1): replace Write-Output with Write-Host for better readability Adding a debug output line before running `Get-ReleaseDescription.ps1` in the GitHub Actions workflow helps in tracking the script execution. Replacing `Write-Output` with `Write-Host` in the PowerShell script improves readability and ensures that messages are displayed in the console, which is more appropriate for status and informational messages.
Include a step to generate a GitHub App token using the `actions/create-github-app-token@v1` action. This token is then used as an environment variable in subsequent steps. This change is necessary to authenticate actions that require GitHub App permissions, enhancing the security and flexibility of the workflow.
…git commands Adding log messages before running `git log` and `git diff` commands provides better visibility into the script's execution flow. This helps in debugging and understanding which part of the script is currently being executed.
… completion of git commands ♻️ (Get-ReleaseDescription.ps1): comment out the pretty format option in git log command for better readability Adding logging statements helps in tracking the execution flow and identifying where the script is during its run. Commenting out the pretty format option in the git log command makes the output more readable and easier to debug.
…ceability Add more detailed logging to the Get-ReleaseDescription function to improve traceability and debugging. This includes messages indicating when changes are found, the full prompt being used, the body of the API request, and the steps of sending the request and extracting the output. This helps in understanding the flow and identifying issues more easily.
…y and debugging Enhance the logging output to make it easier to read and debug. This includes aligning the indentation, adding separators, and providing more context around the extracted result.
Include a new environment variable `nkdAgility_ReleaseDescriptionState` to track the state of the release description. This change helps in determining whether a release description was successfully retrieved or not, improving the robustness and transparency of the CI/CD pipeline.
…d reformat environment variables section The redundant `nkdAgility_ReleaseDescription` entry is removed to avoid duplication and potential confusion. The environment variables section is reformatted for better readability and maintainability.
…ub repository link Add the GitHub repository link to the release instructions to provide a clear reference for users. This helps ensure that contributors know where to find the repository and can follow the correct guidelines for commits.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.