Skip to content

Conversation

@MariusStorhaug
Copy link
Member

@MariusStorhaug MariusStorhaug commented Mar 1, 2025

Description

This pull request includes several changes to improve the handling of sensitive information, enhance the readability of the debug information, and update documentation, including adding a new function to mask sensitive values, updating the README.md to provide clearer information about the action, and modifying the PowerShell script to use the new masking function.

Enhancements to sensitive information handling:

  • action.yml:
    • Fixed the path separator in the script path to ensure compatibility across different environments.
  • scripts/Helpers.psm1:
    • Added a new Set-MaskedValue function to mask sensitive values such as GitHub tokens, JWT tokens, and private keys.
  • scripts/main.ps1:
    • Imported the Helpers.psm1 module and set the output rendering to ANSI for better readability.
    • Updated various logging sections to use the Set-MaskedValue function to mask sensitive information in environment variables and PowerShell variables.

Documentation updates:

  • README.md:
    • Updated the documentation to provide more comprehensive information about the action, including inputs, outputs, and a caution about exposing sensitive information.

Tests:

  • .github/workflows/Action-Test.yml:
    • Added an environment variable for a fake private key for debugging purposes.

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

@MariusStorhaug MariusStorhaug self-assigned this Mar 1, 2025
… in logs and update environment variable display in main.ps1
@MariusStorhaug MariusStorhaug added the Major Breaking change label Mar 1, 2025
@MariusStorhaug MariusStorhaug changed the title 🩹 [Patch]: Fix path separator in action.yml and update README.md 🌟 [Major]: Fix path separator in action.yml and update README.md Mar 1, 2025
@MariusStorhaug MariusStorhaug merged commit 746c946 into main Mar 1, 2025
10 checks passed
@MariusStorhaug MariusStorhaug deleted the fix branch March 1, 2025 14:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Major Breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants