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.

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

Change PSGallery rules to remove 2 rules #1037

Merged
merged 1 commit into from
Jul 13, 2018

Conversation

edyoung
Copy link
Contributor

@edyoung edyoung commented Jul 13, 2018

PR Summary

The PowerShell Gallery currently uses the set of rules in this preset configuration to inform module authors of problems in their modules. The 2 rules in question (AvoidUsingConvertToSecureStringWithPlainText' and 'AvoidUsingUserNameAndPasswordParams' are problematic in that:

  • they form a large fraction of all the violations we report
  • empirically, module authors do not actually fix these. We have some modules where the same violation has been reported for 100's of revision without any change
  • authors frequently have reasons why they cannot abide by the recommendation

This changelist acknowledges reality: since the violation reports are not of value to module authors, we'll drop these rules.

PR Checklist

Note: Tick the boxes below that apply to this pull request by putting an x between the square brackets. Please mark anything not applicable to this PR NA.

  • PR has a meaningful title
    • Use the present tense and imperative mood when describing your changes
  • Summarized changes
  • User facing documentation needed
  • Change is not breaking
  • Make sure you've added a new test if existing tests do not effectively test the code changed
  • This PR is ready to merge and is not work in progress
    • If the PR is work in progress, please add the prefix WIP: to the beginning of the title and remove the prefix when the PR is ready

Copy link
Collaborator

@bergmeister bergmeister left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for updating this file to keep it in sync. I don't think that the new rules in PSSA 1.17.1 would be useful to the PSGallery but just wanted to update you that there has been a new release, which includes a lot of misc. bug fixes and perf improvements

@bergmeister bergmeister merged commit a4f3fe4 into development Jul 13, 2018
@bergmeister bergmeister deleted the change_gallery_rules branch July 24, 2018 20:30
bergmeister pushed a commit to bergmeister/PSScriptAnalyzer that referenced this pull request Mar 22, 2019
…inText and PSAvoidUsingUserNameAndPasswordParams rules (PowerShell#1037)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants