From 2babb46b695fdd71434d5db369d408e81c5005d4 Mon Sep 17 00:00:00 2001 From: Ryan Fox-Tyler <60440289+ryanfoxtyler@users.noreply.github.com> Date: Sat, 6 Apr 2024 15:47:00 -0400 Subject: [PATCH] try megalinter --- .github/workflows/ci-lint.yml | 47 -------- .github/workflows/mega-linter.yml | 180 ++++++++++++++++++++++++++++++ .github/workflows/vale.yml | 24 ++++ .gitignore | 1 + .mega-linter.yml | 13 +++ config/lint/.markdownlint.json | 3 - config/lint/actionlint.yaml | 4 - 7 files changed, 218 insertions(+), 54 deletions(-) delete mode 100644 .github/workflows/ci-lint.yml create mode 100644 .github/workflows/mega-linter.yml create mode 100644 .github/workflows/vale.yml create mode 100644 .gitignore create mode 100644 .mega-linter.yml delete mode 100644 config/lint/.markdownlint.json delete mode 100644 config/lint/actionlint.yaml diff --git a/.github/workflows/ci-lint.yml b/.github/workflows/ci-lint.yml deleted file mode 100644 index 79607cd8..00000000 --- a/.github/workflows/ci-lint.yml +++ /dev/null @@ -1,47 +0,0 @@ -name: Lint - -on: - pull_request: - types: - - opened - - reopened - - synchronize - - ready_for_review - -permissions: read-all - -jobs: - super-linter: - name: Super-Linter - runs-on: warp-ubuntu-latest-x64-2x - permissions: - contents: read - packages: read - # to report GitHub Actions status checks - statuses: write - steps: - - name: Checkout Repository - uses: actions/checkout@v4 - with: - # super-linter needs the full git history to get the list of files that changed across commits - fetch-depth: 0 - - - name: Run Super-Linter - uses: super-linter/super-linter/slim@v6.3.1 - env: - LINTER_RULES_PATH: "config/lint" - MARKDOWN_CONFIG_FILE: ".markdownlint.json" - # to report GitHub Actions status checks - GITHUB_TOKEN: ${{ secrets.GH_ACTIONS }} - - vale: - name: Vale Lanugage Review - runs-on: warp-ubuntu-latest-x64-2x - steps: - - uses: actions/checkout@v4 - - uses: errata-ai/vale-action@reviewdog - env: - github_token: ${{ secrets.GH_ACTIONS }} - with: - vale_flags: "--glob=*.mdx" - fail_on_error: true diff --git a/.github/workflows/mega-linter.yml b/.github/workflows/mega-linter.yml new file mode 100644 index 00000000..903bd792 --- /dev/null +++ b/.github/workflows/mega-linter.yml @@ -0,0 +1,180 @@ +# MegaLinter GitHub Action configuration file +# More info at https://megalinter.io +--- +name: MegaLinter + +# Trigger mega-linter at every push. Action will also be visible from +# Pull Requests to main +on: + # Comment this line to trigger action only on pull-requests + # (not recommended if you don't pay for GH Actions) + push: + + pull_request: + branches: + - main + - master + +# Comment env block if you do not want to apply fixes +env: + # Apply linter fixes configuration + # + # When active, APPLY_FIXES must also be defined as environment variable + # (in github/workflows/mega-linter.yml or other CI tool) + APPLY_FIXES: all + + # Decide which event triggers application of fixes in a commit or a PR + # (pull_request, push, all) + APPLY_FIXES_EVENT: pull_request + + # If APPLY_FIXES is used, defines if the fixes are directly committed (commit) + # or posted in a PR (pull_request) + APPLY_FIXES_MODE: commit + +concurrency: + group: ${{ github.ref }}-${{ github.workflow }} + cancel-in-progress: true + +jobs: + megalinter: + name: MegaLinter + runs-on: warp-ubuntu-latest-x64-2x + + # Give the default GITHUB_TOKEN write permission to commit and push, comment + # issues, and post new Pull Requests; remove the ones you do not need + permissions: + contents: write + issues: write + pull-requests: write + + steps: + # Git Checkout + - name: Checkout Code + uses: actions/checkout@v4 + with: + token: ${{ secrets.GH_ACTIONS }} + + # MegaLinter + - name: MegaLinter + + # You can override MegaLinter flavor used to have faster performances + # More info at https://megalinter.io/latest/flavors/ + uses: oxsecurity/megalinter/flavors/documentation@v7 + + id: ml + + # All available variables are described in documentation + # https://megalinter.io/latest/config-file/ + env: + # Validates all source when push on main, else just the git diff with + # main. Override with true if you always want to lint all sources + # + # To validate the entire codebase, set to: + # VALIDATE_ALL_CODEBASE: true + # + # To validate only diff with main, set to: + # VALIDATE_ALL_CODEBASE: >- + # ${{ + # github.event_name == 'push' && + # github.ref == 'refs/heads/main' + # }} + VALIDATE_ALL_CODEBASE: true + + GITHUB_TOKEN: ${{ secrets.GH_ACTIONS }} + + # ADD YOUR CUSTOM ENV VARIABLES HERE TO OVERRIDE VALUES OF + # .mega-linter.yml AT THE ROOT OF YOUR REPOSITORY + + # Upload MegaLinter artifacts + - name: Archive production artifacts + uses: actions/upload-artifact@v4 + if: success() || failure() + with: + name: MegaLinter reports + path: | + megalinter-reports + mega-linter.log + + # Create pull request if applicable + # (for now works only on PR from same repository, not from forks) + - name: Create Pull Request with applied fixes + uses: peter-evans/create-pull-request@v6 + id: cpr + if: >- + steps.ml.outputs.has_updated_sources == 1 && + ( + env.APPLY_FIXES_EVENT == 'all' || + env.APPLY_FIXES_EVENT == github.event_name + ) && + env.APPLY_FIXES_MODE == 'pull_request' && + ( + github.event_name == 'push' || + github.event.pull_request.head.repo.full_name == github.repository + ) && + !contains(github.event.head_commit.message, 'skip fix') + with: + token: ${{ secrets.GH_ACTIONS }} + commit-message: "[MegaLinter] Apply linters automatic fixes" + title: "[MegaLinter] Apply linters automatic fixes" + labels: bot + + - name: Create PR output + if: >- + steps.ml.outputs.has_updated_sources == 1 && + ( + env.APPLY_FIXES_EVENT == 'all' || + env.APPLY_FIXES_EVENT == github.event_name + ) && + env.APPLY_FIXES_MODE == 'pull_request' && + ( + github.event_name == 'push' || + github.event.pull_request.head.repo.full_name == github.repository + ) && + !contains(github.event.head_commit.message, 'skip fix') + run: | + echo "PR Number - ${{ steps.cpr.outputs.pull-request-number }}" + echo "PR URL - ${{ steps.cpr.outputs.pull-request-url }}" + + # Push new commit if applicable + # (for now works only on PR from same repository, not from forks) + - name: Prepare commit + if: >- + steps.ml.outputs.has_updated_sources == 1 && + ( + env.APPLY_FIXES_EVENT == 'all' || + env.APPLY_FIXES_EVENT == github.event_name + ) && + env.APPLY_FIXES_MODE == 'commit' && + github.ref != 'refs/heads/main' && + ( + github.event_name == 'push' || + github.event.pull_request.head.repo.full_name == github.repository + ) && + !contains(github.event.head_commit.message, 'skip fix') + run: sudo chown -Rc $UID .git/ + + - name: Commit and push applied linter fixes + uses: stefanzweifel/git-auto-commit-action@v5 + if: >- + steps.ml.outputs.has_updated_sources == 1 && + ( + env.APPLY_FIXES_EVENT == 'all' || + env.APPLY_FIXES_EVENT == github.event_name + ) && + env.APPLY_FIXES_MODE == 'commit' && + github.ref != 'refs/heads/main' && + ( + github.event_name == 'push' || + github.event.pull_request.head.repo.full_name == github.repository + ) && + !contains(github.event.head_commit.message, 'skip fix') + with: + branch: >- + ${{ + github.event.pull_request.head.ref || + github.head_ref || + github.ref + }} + commit_message: "[MegaLinter] Apply linters fixes" + commit_user_name: megalinter-bot + commit_user_email: nicolas.vuillamy@ox.security diff --git a/.github/workflows/vale.yml b/.github/workflows/vale.yml new file mode 100644 index 00000000..3b352357 --- /dev/null +++ b/.github/workflows/vale.yml @@ -0,0 +1,24 @@ +name: Vale + +on: + pull_request: + types: + - opened + - reopened + - synchronize + - ready_for_review + +permissions: read-all + +jobs: + vale: + name: Vale Lanugage Review + runs-on: warp-ubuntu-latest-x64-2x + steps: + - uses: actions/checkout@v4 + - uses: errata-ai/vale-action@reviewdog + env: + github_token: ${{ secrets.GH_ACTIONS }} + with: + vale_flags: "--glob=*.mdx" + fail_on_error: true diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..549fbd51 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +megalinter-reports/ diff --git a/.mega-linter.yml b/.mega-linter.yml new file mode 100644 index 00000000..98b64bc9 --- /dev/null +++ b/.mega-linter.yml @@ -0,0 +1,13 @@ +# Configuration file for MegaLinter +# +# See all available variables at https://megalinter.io/latest/config-file/ and in linters documentation + +APPLY_FIXES: all + +DISABLE: + - COPYPASTE # Comment to enable checks of excessive copy-pastes + - SPELL # Uncomment to disable checks of spelling mistakes + +SHOW_ELAPSED_TIME: true + +FILEIO_REPORTER: false diff --git a/config/lint/.markdownlint.json b/config/lint/.markdownlint.json deleted file mode 100644 index 73481319..00000000 --- a/config/lint/.markdownlint.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "MD013": false -} \ No newline at end of file diff --git a/config/lint/actionlint.yaml b/config/lint/actionlint.yaml deleted file mode 100644 index 204d9196..00000000 --- a/config/lint/actionlint.yaml +++ /dev/null @@ -1,4 +0,0 @@ -self-hosted-runner: - # Labels of self-hosted runner in array of string - labels: - - warp-ubuntu-latest-x64-2x \ No newline at end of file