-
-
Notifications
You must be signed in to change notification settings - Fork 329
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
Build/better release description #2256
Commits on Aug 7, 2024
-
🔧 (main.yml): integrate OpenAI API for automated release descriptions
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.
Configuration menu - View commit details
-
Copy full SHA for c347098 - Browse repository at this point
Copy the full SHA c347098View commit details -
🔧 (main.yml): update workflow condition to always run steps regardles…
…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.
Configuration menu - View commit details
-
Copy full SHA for d06b4a1 - Browse repository at this point
Copy the full SHA d06b4a1View commit details -
🔧 (main.yml): fix path separator for PowerShell script in GitHub Actions
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.
Configuration menu - View commit details
-
Copy full SHA for 9c63a06 - Browse repository at this point
Copy the full SHA 9c63a06View commit details -
🔧 (main.yml): add upload and download steps for AzureDevOpsMigrationT…
…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.
Configuration menu - View commit details
-
Copy full SHA for 881d4c2 - Browse repository at this point
Copy the full SHA 881d4c2View commit details -
🔧 (main.yml): specify path for downloaded artifact in GitHub Actions …
…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.
Configuration menu - View commit details
-
Copy full SHA for f47cce1 - Browse repository at this point
Copy the full SHA f47cce1View commit details -
🔧 (main.yml): add release description output and adjust artifact uplo…
…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.
Configuration menu - View commit details
-
Copy full SHA for f6f59ea - Browse repository at this point
Copy the full SHA f6f59eaView commit details -
🔧 (main.yml): add nkdAgility_ReleaseDescription to workflow environme…
…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.
Configuration menu - View commit details
-
Copy full SHA for 74c9462 - Browse repository at this point
Copy the full SHA 74c9462View commit details -
🔧 (main.yml): add debug output for running Get-ReleaseDescription.ps1
♻️ (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.
Configuration menu - View commit details
-
Copy full SHA for e9b853c - Browse repository at this point
Copy the full SHA e9b853cView commit details -
🔧 (main.yml): add GitHub App token creation step to workflow
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.
Configuration menu - View commit details
-
Copy full SHA for de74f6b - Browse repository at this point
Copy the full SHA de74f6bView commit details -
💡 (Get-ReleaseDescription.ps1): add log messages to indicate running …
…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.
Configuration menu - View commit details
-
Copy full SHA for c4fb8ba - Browse repository at this point
Copy the full SHA c4fb8baView commit details
Commits on Aug 8, 2024
-
💡 (Get-ReleaseDescription.ps1): add logging to indicate the start and…
… 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.
Configuration menu - View commit details
-
Copy full SHA for 741258d - Browse repository at this point
Copy the full SHA 741258dView commit details -
Configuration menu - View commit details
-
Copy full SHA for ab38886 - Browse repository at this point
Copy the full SHA ab38886View commit details -
💡 (Get-ReleaseDescription.ps1): add additional logging for better tra…
…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.
Configuration menu - View commit details
-
Copy full SHA for c209050 - Browse repository at this point
Copy the full SHA c209050View commit details -
💡 (Get-ReleaseDescription.ps1): improve logging for better readabilit…
…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.
Configuration menu - View commit details
-
Copy full SHA for 3d959bf - Browse repository at this point
Copy the full SHA 3d959bfView commit details -
Configuration menu - View commit details
-
Copy full SHA for f969c03 - Browse repository at this point
Copy the full SHA f969c03View commit details -
Configuration menu - View commit details
-
Copy full SHA for d7d3f04 - Browse repository at this point
Copy the full SHA d7d3f04View commit details -
Configuration menu - View commit details
-
Copy full SHA for 609f640 - Browse repository at this point
Copy the full SHA 609f640View commit details -
Configuration menu - View commit details
-
Copy full SHA for a9e216e - Browse repository at this point
Copy the full SHA a9e216eView commit details -
🔧 (main.yml): add release description state to GitHub Actions workflow
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.
Configuration menu - View commit details
-
Copy full SHA for 9cf5a01 - Browse repository at this point
Copy the full SHA 9cf5a01View commit details -
Configuration menu - View commit details
-
Copy full SHA for 0e3cf12 - Browse repository at this point
Copy the full SHA 0e3cf12View commit details -
Configuration menu - View commit details
-
Copy full SHA for b901c29 - Browse repository at this point
Copy the full SHA b901c29View commit details -
Configuration menu - View commit details
-
Copy full SHA for 46dc76f - Browse repository at this point
Copy the full SHA 46dc76fView commit details -
🔧 (main.yml): remove redundant nkdAgility_ReleaseDescription entry an…
…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.
Configuration menu - View commit details
-
Copy full SHA for 77a9b91 - Browse repository at this point
Copy the full SHA 77a9b91View commit details -
📝 (Get-ReleaseDescription.ps1): update release instructions with GitH…
…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.
Configuration menu - View commit details
-
Copy full SHA for ce562a2 - Browse repository at this point
Copy the full SHA ce562a2View commit details -
Configuration menu - View commit details
-
Copy full SHA for 3c38499 - Browse repository at this point
Copy the full SHA 3c38499View commit details