From 90e7fce3d5ab0ffd19b8c53c0f512ce7b528c425 Mon Sep 17 00:00:00 2001 From: Bernie White Date: Thu, 10 Dec 2020 18:07:14 +1000 Subject: [PATCH] Added repository validation (#51) --- .github/dependabot.yml | 19 +++++++++++ .github/workflows/analyze.yaml | 17 ++++++++++ .ps-rule/OpenSource.Rule.ps1 | 60 ++++++++-------------------------- 3 files changed, 50 insertions(+), 46 deletions(-) create mode 100644 .github/dependabot.yml create mode 100644 .github/workflows/analyze.yaml diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..f833f26 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,19 @@ +# +# Dependabot configuration +# + +# Please see the documentation for all configuration options: +# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates + +version: 2 +updates: + +# Maintain dependencies for GitHub Actions +- package-ecosystem: 'github-actions' + directory: '/' + schedule: + interval: 'daily' + labels: + - 'ci-quality' + reviewers: + - 'microsoft/psrule-rules-kubernetes' diff --git a/.github/workflows/analyze.yaml b/.github/workflows/analyze.yaml new file mode 100644 index 0000000..8f44970 --- /dev/null +++ b/.github/workflows/analyze.yaml @@ -0,0 +1,17 @@ +# +# Repository validation +# +name: Analyze +on: +- pull_request +jobs: + analyze: + name: Analyze repository + runs-on: ubuntu-latest + steps: + + - name: Checkout + uses: actions/checkout@v2 + + - name: Run PSRule analysis + uses: Microsoft/ps-rule@main diff --git a/.ps-rule/OpenSource.Rule.ps1 b/.ps-rule/OpenSource.Rule.ps1 index 2b56edb..948b4a4 100644 --- a/.ps-rule/OpenSource.Rule.ps1 +++ b/.ps-rule/OpenSource.Rule.ps1 @@ -2,53 +2,21 @@ # Licensed under the MIT License. # Synopsis: Check for recommended community files -Rule 'OpenSource.Community' -Type 'System.IO.DirectoryInfo' { - $requiredFiles = @( - 'CHANGELOG.md' - 'LICENSE' - 'CODE_OF_CONDUCT.md' - 'CONTRIBUTING.md' - 'SECURITY.md' - 'README.md' - '.github/CODEOWNERS' - '.github/PULL_REQUEST_TEMPLATE.md' - ) - Test-Path -Path $TargetObject.FullName; - for ($i = 0; $i -lt $requiredFiles.Length; $i++) { - $filePath = Join-Path -Path $TargetObject.FullName -ChildPath $requiredFiles[$i]; - $Assert.Create((Test-Path -Path $filePath -PathType Leaf), "$($requiredFiles[$i]) does not exist"); - } +Rule 'OpenSource.Community' -Type 'PSRule.Data.RepositoryInfo' { + $Assert.FilePath($TargetObject, 'FullName', @('CHANGELOG.md')); + $Assert.FilePath($TargetObject, 'FullName', @('LICENSE')); + $Assert.FilePath($TargetObject, 'FullName', @('CODE_OF_CONDUCT.md')); + $Assert.FilePath($TargetObject, 'FullName', @('CONTRIBUTING.md')); + $Assert.FilePath($TargetObject, 'FullName', @('SECURITY.md')); + $Assert.FilePath($TargetObject, 'FullName', @('README.md')); + $Assert.FilePath($TargetObject, 'FullName', @('.github/CODEOWNERS')); + $Assert.FilePath($TargetObject, 'FullName', @('.github/PULL_REQUEST_TEMPLATE.md')); } # Synopsis: Check for license in code files -Rule 'OpenSource.License' -Type 'System.IO.FileInfo' -If { $TargetObject.Extension -in '.cs', '.ps1', '.psd1', '.psm1' } { - $commentPrefix = "`# "; - if ($TargetObject.Extension -eq '.cs') { - $commentPrefix = '// ' - } - $header = GetLicenseHeader -CommentPrefix $commentPrefix; - $content = Get-Content -Path $TargetObject.FullName -Raw; - $content.StartsWith($header); -} - -function global:GetLicenseHeader { - [CmdletBinding()] - [OutputType([String])] - param ( - [Parameter(Mandatory = $True)] - [String]$CommentPrefix - ) - process { - $text = @( - 'Copyright (c) Microsoft Corporation.' - 'Licensed under the MIT License.' - ) - $builder = [System.Text.StringBuilder]::new(); - foreach ($line in $text) { - $Null = $builder.Append($CommentPrefix); - $Null = $builder.Append($line); - $Null = $builder.Append([System.Environment]::NewLine); - } - return $builder.ToString(); - } +Rule 'OpenSource.License' -Type '.cs', '.ps1', '.psd1', '.psm1' { + $Assert.FileHeader($TargetObject, 'FullName', @( + 'Copyright (c) Microsoft Corporation.' + 'Licensed under the MIT License.' + )); }