Skip to content

Enhance documentation templates#124

Merged
marko-stanojevic merged 6 commits intomainfrom
fix/integration-tests
Jan 27, 2026
Merged

Enhance documentation templates#124
marko-stanojevic merged 6 commits intomainfrom
fix/integration-tests

Conversation

@marko-stanojevic
Copy link
Contributor

@marko-stanojevic marko-stanojevic commented Jan 27, 2026

Description

This pull request introduces several improvements to the documentation templates, CI/CD workflows, and release automation for the PowerShell module project. The main changes include enhanced documentation templates, improved handling of release and publishing workflows, and the addition of a labeling job in CI. These updates aim to make the project easier to maintain, more robust, and more user-friendly for both contributors and end-users.

Documentation and Template Enhancements:

  • Added an "About" section and improved introductory content in the README_template.md to better describe the module's purpose and benefits.
  • Added a new getting-started_template.md with sections for overview, features, workflows, best practices, and troubleshooting, providing a comprehensive starting point for users.
  • Updated workflow to use the new documentation templates and ensure placeholders are correctly replaced with module-specific information. [1] [2]

CI/CD and Release Workflow Improvements:

  • Improved the release workflow to use the correct secret for publishing to the PowerShell Gallery and refactored environment variable usage for better security and clarity.
  • Enhanced the ps-release action to handle the case where no previous tag exists when generating release notes, and added support for an optional PSGallery API key secret. [1] [2] [3]

Continuous Integration Enhancements:

  • Added a new "Label Changes" job to the CI workflow to automatically apply labels to pull requests, improving project organization and review efficiency.

Testing Improvements:

  • Updated integration tests to require at least one public function file instead of exactly one, making tests more flexible as the module grows.

Documentation Structure Refinement:

  • Refined documentation links and structure in the README_template.md, consolidating example and getting started sections for clarity.

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update
  • Code quality improvement (refactoring, tests, performance)

@github-actions github-actions bot added ci-cd Github configuration files github tests Related to tests bugfix Bug fix labels Jan 27, 2026
@marko-stanojevic marko-stanojevic merged commit ed2a4f5 into main Jan 27, 2026
10 checks passed
@marko-stanojevic marko-stanojevic deleted the fix/integration-tests branch January 27, 2026 21:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bugfix Bug fix ci-cd Github configuration files github tests Related to tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant