Skip to content

Conversation

@MariusStorhaug
Copy link
Member

@MariusStorhaug MariusStorhaug commented Mar 8, 2025

Description

This pull request includes several updates to the GitHub Actions workflow configuration and documentation. The changes primarily focus on enhancing test result outputs and adding a new test job.

Key changes include:

Workflow Configuration Updates:

Documentation Updates:

  • README.md: Updated the test outcome section to include new output fields (Executed, Result, PassedCount, FailedCount, SkippedCount, InconclusiveCount, NotRunCount, TotalCount). Also updated the example workflow to use PSModule/Invoke-Pester@v3. [1] [2] [3]

Other Minor Changes:

Type of change

  • 📖 [Docs]
  • 🪲 [Fix]
  • 🩹 [Patch]
  • ⚠️ [Security fix]
  • 🚀 [Feature]
  • 🌟 [Breaking change]

Checklist

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas

Copilot AI review requested due to automatic review settings March 8, 2025 10:23
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Overview

This pull request updates the default working directory from an absolute path (using "${{ github.workspace }}") to a relative path ('.') and updates the corresponding documentation.

  • Changed the default working directory in action.yml from "${{ github.workspace }}" to "."
  • Updated the README.md to reflect the new default working directory

Reviewed Changes

File Description
action.yml Updated default working directory setting
README.md Updated documentation to reflect the new default

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (2)

action.yml:208

  • Changing the default working directory from '${{ github.workspace }}' to '.' may lead to path resolution issues if the script does not explicitly resolve the relative path. Consider ensuring that the behavior is consistent with the expected runtime environment.
default: '.'

README.md:305

  • The documentation now shows '.' as the default working directory. It would be helpful to clarify how this relative path is resolved in the execution context.
| `WorkingDirectory`                   | The working directory where the script runs.                                                           | `'.'`       |

…g outcome properties and enhancing error checks
…ction.yml and update README.md with usage examples
… and remove redundant outcome checks in action.yml
@MariusStorhaug MariusStorhaug requested a review from Copilot March 8, 2025 14:33
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Overview

This PR updates the default working directory to a relative path and enhances test file discovery plus reporting by introducing additional outputs and modifying step names and logic in the GitHub workflows. Key changes include:

  • Changing the default working directory from ${{ github.workspace }} to '.' and adding multiple output parameters.
  • Refactoring the test execution steps by renaming and splitting execution into separate scripts.
  • Updating workflow jobs to use new output names and additional status checks.

Reviewed Changes

File Description
action.yml Changes to default working directory, added outputs, and refactored test execution and status reporting.
README.md Updated documentation to reflect new outputs and version bumps.
.github/workflows/Action-Test.yml Adjusted outputs names and updated status-check logic in test workflows.
.github/workflows/Auto-Release.yml Removed the GITHUB_TOKEN environment variable from the auto-release job.

Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.

@MariusStorhaug MariusStorhaug self-assigned this Mar 8, 2025
@MariusStorhaug MariusStorhaug requested a review from Copilot March 8, 2025 15:21
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Overview

This PR updates the default working directory to a relative path ('.') and enhances test file discovery by introducing separate searches for root and subfolders, while also updating documentation and workflow files to reflect these changes.

  • Update working directory default in action.yml
  • Introduce new outputs and adjust step names in action.yml
  • Update README.md and workflow files to match new outputs and improve testing status aggregation

Reviewed Changes

File Description
action.yml Changes the default working directory and adds output definitions; updates test invocation and status reporting steps.
README.md Updates documentation to reflect new outputs and changes in test result reporting.
.github/workflows/Action-Test.yml Updates output names and aggregates test results with revised comparisons.
.github/workflows/Auto-Release.yml Removes the GITHUB_TOKEN environment variable from the Auto-Release job.

Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (2)

action.yml:374

  • Comparing the boolean variable $executed to the string 'true' may lead to unexpected behavior; consider using a direct boolean check (e.g., if (-not $executed)).
if ($executed -ne 'true') {

.github/workflows/Auto-Release.yml:32

  • Removal of the GITHUB_TOKEN environment variable may prevent proper authentication for the Auto-Release action; verify that this change is intentional.
-          GITHUB_TOKEN: ${{ github.token }}

@MariusStorhaug MariusStorhaug merged commit 42d2652 into main Mar 8, 2025
12 checks passed
@MariusStorhaug MariusStorhaug deleted the fixWorkingDir branch March 8, 2025 15:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants