2023-01-21 09:52:17 +00:00
---
# MegaLinter GitHub Action configuration file
# More info at https://megalinter.github.io
name : MegaLinter
on :
# Trigger mega-linter at every push. Action will also be visible from Pull Requests to main
2023-04-17 07:19:19 +00:00
#push: # Comment this line to trigger action only on pull-requests (not recommended if you don't pay for GH Actions)
2023-01-21 09:52:17 +00:00
pull_request :
2023-05-19 07:06:50 +00:00
branches : [ main]
2023-01-21 09:52:17 +00:00
permissions :
contents : write
2023-05-18 15:21:48 +00:00
issues : write
2023-01-21 09:52:17 +00:00
pull-requests : write
env : # Comment env block if you do not want to apply fixes
# Apply linter fixes configuration
APPLY_FIXES : all # When active, APPLY_FIXES must also be defined as environment variable (in github/workflows/mega-linter.yml or other CI tool)
APPLY_FIXES_EVENT : all # Decide which event triggers application of fixes in a commit or a PR (pull_request, push, all)
APPLY_FIXES_MODE : pull_request # If APPLY_FIXES is used, defines if the fixes are directly committed (commit) or posted in a PR (pull_request)
concurrency :
group : ${{ github.ref }}-${{ github.workflow }}
cancel-in-progress : true
jobs :
build :
name : MegaLinter
runs-on : ubuntu-latest
2023-05-19 07:06:50 +00:00
environment :
name : megalinter
2023-01-21 09:52:17 +00:00
continue-on-error : true
steps :
# Git Checkout
- name : Checkout Code
2023-09-11 06:54:10 +00:00
uses : actions/checkout@v4
2023-01-21 09:52:17 +00:00
with :
2023-05-19 07:06:50 +00:00
token : ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
2023-01-21 09:52:17 +00:00
fetch-depth : 0
# MegaLinter
- name : MegaLinter
id : ml
# You can override MegaLinter flavor used to have faster performances
# More info at https://megalinter.github.io/flavors/
2023-10-30 10:15:47 +00:00
uses : oxsecurity/megalinter@b48455a119cc28045eee8f1e9d0a542a85e71f4f # v7.5.0
2023-01-21 09:52:17 +00:00
env :
# All available variables are described in documentation
# https://megalinter.github.io/configuration/
2023-04-01 14:08:52 +00:00
VALIDATE_ALL_CODEBASE : ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} # 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
2023-01-21 09:52:17 +00:00
GITHUB_TOKEN : ${{ secrets.GITHUB_TOKEN }}
SPELL_CSPELL_CONFIG_FILE : .github/cspell.json
2023-01-21 11:10:46 +00:00
POWERSHELL_POWERSHELL_CONFIG_FILE : .github/.powershell-psscriptanalyzer.psd1
2023-04-18 12:57:03 +00:00
DISABLE_ERRORS_LINTERS : REPOSITORY_DEVSKIM,REPOSITORY_CHECKOV,REPOSITORY_GIT_DIFF,SPELL_CSPELL,SPELL_PROSELINT,COPYPASTE_JSCPD,MARKDOWN_MARKDOWN_LINK_CHECK
2023-04-18 12:41:35 +00:00
FILTER_REGEX_EXCLUDE : (workflows/)
2023-10-03 09:32:22 +00:00
REPOSITORY_TRUFFLEHOG_DISABLE_ERRORS_IF_LESS_THAN : 2
2023-11-04 14:20:07 +00:00
REPORT_OUTPUT_FOLDER : none #set due to https://github.com/oxsecurity/megalinter/issues/1975
2023-01-21 09:52:17 +00:00
# Upload MegaLinter artifacts
- name : Archive production artifacts
if : ${{ success() }} || ${{ failure() }}
uses : actions/upload-artifact@v3
with :
name : MegaLinter reports
path : |
report
mega-linter.log
if-no-files-found : ignore
# Create pull request if applicable (for now works only on PR from same repository, not from forks)
- name : Create Pull Request with applied fixes
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')
2023-10-30 10:15:47 +00:00
uses : peter-evans/create-pull-request@153407881ec5c347639a548ade7d8ad1d6740e38 # v5.0.2
2023-01-21 09:52:17 +00:00
with :
2023-05-19 07:06:50 +00:00
token : ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
2023-01-21 09:52:17 +00:00
commit-message : "[MegaLinter] Apply linters automatic fixes"
title : "[MegaLinter] Apply linters automatic fixes"
labels : bot
2023-10-11 13:32:55 +00:00
base : ${{ github.head_ref }}
2023-01-21 09:52:17 +00:00
- 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 "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}"
echo "Pull Request 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
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')
2023-10-30 10:15:47 +00:00
uses : stefanzweifel/git-auto-commit-action@8756aa072ef5b4a080af5dc8fef36c5d586e521d # v5.0.0
2023-01-21 09:52:17 +00:00
with :
branch : ${{ github.event.pull_request.head.ref || github.head_ref || github.ref }}
commit_message : "[MegaLinter] Apply linters fixes"