Reviewing Github Actions and update references #115
Merged
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.
Description
This pull request restructures and modernizes the GitHub Actions CI/CD workflows for the PowerShell module template. The main changes involve renaming workflow files for clarity, updating workflow references to use local files instead of remote templates, and improving documentation and badges to match the new workflow structure. There are also minor improvements to documentation and VSCode settings.
Workflow and CI/CD Structure Improvements:
All GitHub Actions workflow files have been renamed for clarity (e.g.,
ci.yml→github-ci.yml,github-release.yml→release.yml, and template files now useps-prefixes). Workflow references in.github/workflows/github-ci.ymland.github/workflows/release.ymlhave been updated to use these local, renamed workflows instead of remote templates. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12]Workflow file names and job names have been updated for consistency and clarity (e.g., removing
[template]from workflownamefields). [1] [2] [3] [4] [5]Documentation and Badge Updates:
README.mdCI badge and code coverage badge now point to the newgithub-ci.ymlworkflow.docs/ci-cd.md) has been updated to reference the new workflow file names and clarify their behavior, including improved descriptions of semantic versioning keywords and release automation. [1] [2] [3] [4]Developer Experience Improvements:
MD036markdown lint rule to allow emphasis instead of headings.Testing Improvements:
Get-ModuleMetadata.Tests.ps1to improve Pester test context readability.Type of Change