microsoft / microsoft/PSRule

[FEATURE] Add customizable support message

Open
#2,666 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature: output
Dominant language
C#
Stars
474
Forks
65
Avg merge
22h 25m
Merged PRs (30d)
26

Description

Your suggestion

Currently the output of PSRule is pre-defined pointing to PSRule repos and docs.

However, for the specific use case that PSRule is adopted for there may be a more relevant support path within an organization.

This feature would allow adding a customizable message to the top of PSRule output to allow an organization / use case specific message to be inserted.

This should also be inserted into the job summary and SARIF rule content.

The option will be configured by setting Output.Message with plain text or markdown.

Alternatives

n/a

Additional context

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the Output.Message configuration and trace how PSRule output is generated. Check the existing output, job summary, and SARIF rule content paths, then verify that a plain-text or Markdown message appears in all three places when configured.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, powershell
Domain
devops, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.