Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Enforce PowerShell Linter Rules #175

Open
2 tasks
adhilto opened this issue Jan 30, 2024 · 5 comments · May be fixed by #325
Open
2 tasks

Enforce PowerShell Linter Rules #175

adhilto opened this issue Jan 30, 2024 · 5 comments · May be fixed by #325
Assignees
@mitchelbaker-cisa
Labels
Points: 6 Story Point (3 days)
Milestone
LME 2.0

Comments

@adhilto
Copy link
Contributor

adhilto commented Jan 30, 2024

Is your feature request related to a problem? Please describe.
The linter workflow is currently configured to always pass, regardless of anything it might find. As a result, code that does not meet its standards can (and has been) merged into main.

Describe the solution you'd like

  • Modify all existing PowerShell scripts to meet the linter's standard
  • Modify the workflow to enforce the linter rules

Describe alternatives you've considered
N/A

Additional context
N/A
@adhilto adhilto added the improvement This issue or pull request will add new or improve existing functionality label Jan 30, 2024
@adhilto adhilto mentioned this issue Jan 30, 2024
Merged
9 tasks
@aarz-snl
Copy link
Collaborator

Will need to run through and add 'exceptions' to items as well for items we see has not needing a 'fix'

@cbaxley
Copy link
Collaborator

cbaxley commented Feb 12, 2024

What level will we throw on? Are warn OK?

@adhilto
Copy link
Contributor Author

adhilto commented Feb 12, 2024

I personally don't think warning would be enough. If the linter doesn't cause the workflow to fail, I won't see it. So my preference would be to fail, not warn, but to add exceptions for anything we don't actually care about.

@llwaterhouse llwaterhouse added this to the Backlog milestone Feb 13, 2024
@mitchelbaker-cisa mitchelbaker-cisa self-assigned this Feb 29, 2024
@mitchelbaker-cisa mitchelbaker-cisa modified the milestones: Backlog, Elm Feb 29, 2024
@llwaterhouse
Copy link
Contributor

Additional comments from Alden:

Here's how you can get more details:
Open any of the current open PRs
Scroll down to the bottom, then where it says "All checks have passed," click "Show all checks."
Click "Details" by the lint check
Expand the results for the "Lint PowerShell Scripts" check. You'll see that PowerShell currently results in about 20 warnings.
It's all just style best-practice stuff, nothing critical. I don't think it would be too hard to fix them. Probably about a week.

Image

@llwaterhouse llwaterhouse modified the milestones: Elm, Backlog Mar 1, 2024
@llwaterhouse
Copy link
Contributor

Would this be a good candidate to try using Github Copilot?

@mitchelbaker-cisa mitchelbaker-cisa modified the milestones: Backlog, Elm Mar 21, 2024
@safiuddinr safiuddinr added Points: 6 Story Point (3 days) and removed improvement This issue or pull request will add new or improve existing functionality labels May 13, 2024
@mitchelbaker-cisa mitchelbaker-cisa linked a pull request Jun 4, 2024 that will close this issue
Open
10 tasks
@mitchelbaker-cisa mitchelbaker-cisa removed this from the Elm-1.4.0 milestone Jun 5, 2024
@safiuddinr safiuddinr added this to the LME 2.0 milestone Oct 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mitchelbaker-cisa mitchelbaker-cisa

Labels
Points: 6 Story Point (3 days)
Projects
LME-Development
Status: 👀 In Review
Milestone
LME 2.0
Development

Successfully merging a pull request may close this issue.

Enforce powershell linter rules cisagov/LME
6 participants
@cbaxley @llwaterhouse @adhilto @mitchelbaker-cisa @aarz-snl @safiuddinr