Skip to content

Conversation

@marko-stanojevic
Copy link
Contributor

Description

This pull request introduces comprehensive documentation and process improvements for the PSScriptModule project, focusing on development workflow, build and test automation, CI/CD pipeline, publishing, maintenance, and community standards. The updates provide clear guidance for contributors and ensure robust automation and quality control throughout the module lifecycle.

Documentation and Workflow Enhancements

  • Added detailed guides for creating, testing, and exporting new functions, including examples for function and test files, and instructions for updating the module manifest. (docs/development.md)
  • Documented build tasks and usage of Invoke-Build, covering cleaning, building, testing, code analysis, security scanning, documentation generation, publishing, and build configuration options. (docs/building.md)
  • Provided instructions for generating help files with PlatyPS, including markdown and MAML formats, and examples for accessing help in PowerShell. (docs/generating-help.md)
  • Added testing documentation detailing how to run unit, analysis, and security tests, including code coverage and output formats. (docs/testing.md)

Automation and CI/CD Improvements

  • Introduced a comprehensive CI/CD pipeline guide, describing workflow structure, triggers, build types, semantic versioning strategy, and commit message conventions for automated releases. (docs/ci-cd.md)
  • Documented publishing process to PowerShell Gallery, including manual and automated methods, secret configuration, and manual workflow dispatch options. (docs/publishing.md)
  • Added automated maintenance workflow documentation for artifact and workflow run cleanup, with configurable retention and scheduling. (docs/maintenance.md)

Community and Contribution Guidelines

  • Added a new Code of Conduct to set expectations for behavior, standards, and enforcement responsibilities within the community. (.github/CODE_OF_CONDUCT.md)
  • Updated the contributing guide to reflect the correct project name and reinforce adherence to the Code of Conduct. (CONTRIBUTING.md)

@marko-stanojevic marko-stanojevic merged commit b458d50 into main Jan 20, 2026
1 check passed
@marko-stanojevic marko-stanojevic deleted the feat/documentation_update branch January 20, 2026 21:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants