Handled sentinel policy scenario for copywrite header

[sonamtenzin6]

🛠️ Description

We need to skip sentinel policy text before adding the copywrite header. Added regex to match the pattern for sentinel policy and skip the lines

Added new function to match regex patterns which can be skipped while running on files

🔗 External Links

https://hashicorp.atlassian.net/browse/IND-2193

👍 Definition of Done

• New functionality works?
• Tests added?

🤔 Can be merged upon approval?

✅

[sonamtenzin6]

Able to build the branch on local, the build executrables failed because of depreciated upload-artifact action

[CalebAlbers]

Hey there! Could I ask for a bit more context on why Sentinel policies need to be excluded? It feels like this change will only skip copyright headers on some sentinel policies, but not others.

I don't have the full context on whether Sentinel policies need/can have copyright headers attached. I will mention that if it is due to things like auto-generated documentation getting the copyright header, too, Copywrite has the ability to add a .copywrite.hcl config that excludes individual files, whole folders, or other search globs.

Depending on the use case, there may be more robust mechanisms for achieving the end result without making assumptions inside the code that other parties have to contend with (e.g., the other companies and individuals that use Copywrite outside of HashiCorp).

[CalebAlbers]

Do Sentinel policies themselves enforce comments at the top of strings that use this format?

I could be wrong, but it feels like this route may not be robust in the face of sentinel policies that start with other verbiage. A contrived example would be one that starts with:

# These policies require...

Here is an example of a Sentinel policy that starts with a different top line: https://github.com/hashicorp/vault-guides/blob/master/governance/sentinel/cidr-policy.sentinel

A cursory search on GitHub shows that most people use the .sentinel extension. Could that be a viable alternative to match on instead?

[mukeshjc]

@CalebAlbers

TLDR
your assessment is accurate. I have synced with @sonamtenzin6 to publish an updated PR that will handle our requirements in a better way for all ".sentinel" files.

Long form
HashiCorp's pre-written sentinel policy libraries conventionally use top file comments for policy descriptions, which TFC UI displays. The current copyright headers disrupt this by appearing first, causing TFC UI to display them instead of policy descriptions.
To address this urgently, we will:

1. Add support for .sentinel files in copywrite tool
2. Place copyright headers after top comments in sentinel policies to maintain TFC UI functionality

This workaround accommodates TFC's current comment parsing behavior while preserving both policy descriptions and copyright information.