Refactor and enhance GitHub Actions workflow and documentation#15
Merged
Refactor and enhance GitHub Actions workflow and documentation#15
Conversation
…nce module build steps
…ishing instructions
…reate GitHub releases
…file creation is forced and improve path handling for non-Windows systems
…tHub Actions workflow
…ndows in GitHub Actions workflow
…ublishing details
This file contains hidden or 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
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.
This pull request introduces several improvements to the build, test, and release automation for the PowerShell module, with a focus on modernizing the CI/CD workflows, enhancing developer experience, and improving documentation. The most significant changes include updating GitHub Actions workflows for publishing and testing, enhancing the
Build.ps1script with new options and better error handling, and refining documentation for clarity.CI/CD Workflow Improvements:
publish.ymlworkflow now triggers on new version tags, builds and tests the module, generates build attestations, and creates a GitHub release with the zipped module attached. The workflow uses updated actions and includes steps for provenance attestation and future PowerShell Gallery publishing.test.ymlworkflow now runs on both Ubuntu and Windows, only triggers for relevant file changes, uses updated actions, and builds the module before running tests.Build Script Enhancements:
Build.ps1now accepts-Configuration,-TargetFramework, and-Cleanparameters, supports cleaning before build, handles locked DLL errors gracefully, and provides improved output and error messages. [1] [2] [3]Developer Experience:
.vscode/tasks.jsonwas updated so the build task defaults toDebugconfiguration, and the test task now builds the module before running tests, ensuring a consistent test environment. [1] [2]Documentation Updates:
README.mdnow provides clearer build and test instructions, details the automated publishing process, and emphasizes the need to updateModuleVersionbefore releases.