🚀[Feature]: Control if GitHub credentials are persisted

[Copilot]

You now have the option to decide if your GitHub credentials should be kept or automatically disconnected after the script finishes. This gives you more flexibility and helps improve security when needed.

• Fixes 🩹 [Patch]: Add 'preserve-credentials' switch. #39

How It Works

• By default, your GitHub credentials will be preserved, just like before—no changes needed on your part.
• If you want your credentials to be automatically disconnected after the script runs, set the new PreserveCredentials option to false.

Example

Here’s how to disconnect your credentials after running a script:

- name: Run script with credential cleanup
  uses: PSModule/GitHub-Script@v1
  with:
    PreserveCredentials: false
    Script: |
      Get-GitHubUser
      # Your credentials will be disconnected after this step

That’s it! Use this new option if you want to make sure your GitHub connection is cleaned up automatically after your workflow.

[Copilot]

Pull Request Overview

This PR introduces a new PreserveCredentials input to let users choose whether GitHub credentials are disconnected after the action runs.

• Added a PreserveCredentials input (default 'true') in action.yml
• Mapped the new input to an environment variable and updated scripts/clean.ps1 to conditionally call Disconnect-GitHubAccount
• Updated README.md to document the new parameter

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File	Description
scripts/clean.ps1	Added logic to disconnect GitHub contexts/CLI when PreserveCredentials is false
action.yml	Defined PreserveCredentials input and passed it into the script environment
README.md	Added PreserveCredentials entry to the inputs table

Comments suppressed due to low confidence (2)

scripts/clean.ps1:29

• Assigning an environment variable to a boolean literal can lead to type inconsistencies; consider explicitly setting it to the string 'false' to match existing string-based checks and avoid confusion.

$env:PSMODULE_GITHUB_SCRIPT = $false

scripts/clean.ps1:9

• The conditional branch for disconnecting credentials isn't covered by existing tests; consider adding tests for both PreserveCredentials: 'true' and 'false' scenarios to validate the cleanup logic.

if (-not $preserveCredentials) {

[MariusStorhaug]

Add this example to the readme:

- name: Run script with credential cleanup
  uses: PSModule/GitHub-Script@v1
  with:
    PreserveCredentials: false
    Script: |
      Get-GitHubUser
      # Credentials will be disconnected after this step

[Copilot]

Add this example to the readme:

- name: Run script with credential cleanup

...

Added the example to the README as Example 6 with a descriptive title. Commit: 968f8f0

[MariusStorhaug]

Add a test that sets PersistCredentials to false, and runs a new powershell step after to see if there are any contexts using Get-GitHubContext -ListAvailable. This value should be null.

[Copilot]

Add a test that sets PersistCredentials to false, and runs a new powershell step after to see if there are any contexts using Get-GitHubContext -ListAvailable. This value should be null.

Added a test that sets PreserveCredentials to false and verifies credentials are cleaned up using Get-GitHubContext -ListAvailable. The test ensures no contexts remain after cleanup. Commit: 1d4ed59