Releases: PSModule/GitHub-Script
v1.6.2
🪲 [Fix]: Fix setting the $ErrorView
setting via inputs (#53)
This pull request introduces changes related to the handling of the ErrorView
configuration in a GitHub Actions workflow. The changes streamline the ErrorView
initialization logic by removing redundant code and adding validation to ensure ErrorView
is set correctly during runtime.
Changes to ErrorView
handling:
.github/workflows/TestWorkflow.yml
: Added a validation step to confirm thatErrorView
is set to'NormalView'
during the workflow execution. If not, an exception is thrown.action.yml
: Introduced the assignment of theErrorView
environment variable from the input parameter for use in subsequent scripts.scripts/init.ps1
: Removed the redundant initialization and validation logic forErrorView
, as this is now handled directly in the workflow and action configuration.
v1.6.1
🩹 [Patch]: Updated the org level login test with quotes (#52)
Description
This pull request updates the TestWorkflow.yml
file to test quoted inputs for GitHub App secrets and adjusts the job name to reflect this change.
Workflow updates:
.github/workflows/TestWorkflow.yml
: Updated thename
field of theActionTestWithGitHubAppOrg
job to include "quoted inputs" for clarity..github/workflows/TestWorkflow.yml
: Modified theClientID
andPrivateKey
inputs in theAction-Test
step to use quoted syntax for testing purposes.
v1.6.0
🚀[Feature]: Control if GitHub credentials are persisted (#50)
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.
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 tofalse
.
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.
v1.5.1
🩹 [Patch]: Add tests for logging commands for GitHub Actions workflow (#51)
Description
This pull request adds tests various log functions that work in GitHub Actions.
Logging enhancements:
.github/workflows/TestWorkflow.yml
: Added some tests to show how log notices, warnings, errors, debug messages, and styled log messages with foreground and background colors work.
v1.5.0
🚀 New Feature: ErrorView
Configuration
This release introduces a new feature to configure the PowerShell $ErrorView
variable in the GitHub Action. This also sets the default to NormalView
whereas the default in PowerShell is ConciseView
. NormalView
provides more information that would be great to get when troubleshooting errors in GitHub workflows. Users can still override this by adding their own settings in the provided script or using the input to set a different value when building actions or workflows.
Details
- Introduced the
ErrorView
input inaction.yml
, including its description, default value ('NormalView'
), and marking it as optional. - The input is mapped to the new environment variable
PSMODULE_GITHUB_SCRIPT_INPUT_ErrorView
in theaction.yml
file. - The environment variable is validated using wildcard matching against a predefined list of valid views, applies the matched view setting.
- Added a description for the new
ErrorView
option in theREADME.md
file. This option allows users to configure the$ErrorView
variable using full or partial names of valid views.
v1.4.12
What's Changed
- 🩹 [Patch]: Update Action name to be that of the
Name
input by @MariusStorhaug in #48
Full Changelog: v1...v1.4.12
v1.4.11
v1.4.10
What's Changed
- 🩹 [Patch]: Enable reinstall of modules to ensure the correct version of
GitHub
is installed by @MariusStorhaug in #46
Full Changelog: v1...v1.4.10
v1.4.9
What's Changed
- 🩹 [Patch]: Update default values for WorkingDirectory to be '.' by @MariusStorhaug in #45
Full Changelog: v1...v1.4.9
v1.4.8
What's Changed
- 🩹 [Patch]: Update scripts to output as strings by @MariusStorhaug in #44
Full Changelog: v1...v1.4.8