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

Import mega-linter.yml #678

Merged
merged 27 commits into from
Oct 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
8ddfdf7
Import mega-linter.yml. Fix #147.
gwarf Oct 11, 2024
e44bfbd
Merge branch 'main' into enable_mega_linter
gwarf Oct 12, 2024
80742f3
Tidy up some comments
gwarf Oct 12, 2024
1b50056
Tidy up some comments, bis
gwarf Oct 12, 2024
8cdd989
Shorten long lines
gwarf Oct 12, 2024
8761091
Switch megalinter to documentation flavor
gwarf Oct 13, 2024
4ad8d0c
Try to address linte reports
gwarf Oct 13, 2024
e4e918d
Disable COPYPASTE and SPELL
gwarf Oct 13, 2024
56c8695
Configure secretlint
gwarf Oct 13, 2024
25dfe3a
Disable GRYPE
gwarf Oct 13, 2024
9029bb9
Merge branch 'main' into enable_mega_linter
gwarf Oct 13, 2024
9403e9b
Gitleaks only changes for PR and for everything for the rest
gwarf Oct 13, 2024
8a3fdb9
Update exclusions
gwarf Oct 13, 2024
820c18d
Harden more top-level permissions
gwarf Oct 13, 2024
846a6f2
Fix secretlint conf
gwarf Oct 13, 2024
2dcc2bd
Remove trufflehog, keeping gitleaks and secretlint
gwarf Oct 13, 2024
6c21ae8
Address last too open top-level permissions
gwarf Oct 13, 2024
1313392
Fix yaml lint
gwarf Oct 13, 2024
f6b2d7b
Try to fix secret for secretlint
gwarf Oct 13, 2024
06de70b
Only exclude CSPELL not all SPELL, see https://megalinter.io/latest/d…
gwarf Oct 13, 2024
05ee1cc
Aheum...
gwarf Oct 13, 2024
a5f4519
Document gitleaks configuration
gwarf Oct 13, 2024
70848fc
Try yet another way to pass option to secretlinter
gwarf Oct 13, 2024
e09d1a5
Update lychee configuration
gwarf Oct 13, 2024
38c3da0
Try yet another way to pass option to secretlinter. ;(
gwarf Oct 13, 2024
fde7240
Replace commit info
gwarf Oct 15, 2024
b21faa0
Merge branch 'main' into enable_mega_linter
gwarf Oct 21, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions .github/linters/.secretlintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"rules": [
{
"id": "@secretlint/secretlint-rule-preset-recommend",
"rules": [
{
"id": "@secretlint/secretlint-rule-basicauth",
"options": {
"allows": [ "/secret/i" ]
}
}
]
}
]
}
2 changes: 2 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ name: Build documentation

on: [pull_request]

permissions: read-all

jobs:
build:
name: Build with Hugo
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/build_pr_preview.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ on:
# Run when label is added or present and when pushing to the PR
types: [labeled, opened, synchronize]

permissions: read-all

jobs:
build_preview:
# Do not run on forks, and only if "safe for preview" label is set
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/check-links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ on:
# run on Sundays morning
- cron: '32 9 * * 0'

permissions: read-all

jobs:
markdown-link-check:
name: Check links using markdown-link-check
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/delete_pr_preview.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ on:
# Run when label is removed or pull request closed
types: [unlabeled, closed]

permissions: read-all

jobs:
delete_preview:
# Do not run on forks, and only if "safe for preview" label is set
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ on:
branches:
- main

permissions: read-all

jobs:
deploy:
name: Build using Hugo and deploy
Expand Down
5 changes: 2 additions & 3 deletions .github/workflows/deploy_pr_preview.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ on:
workflows: ["Build pull request preview"]
types: [completed]

permissions: read-all

jobs:
deploy_pr_preview:
# Only run if PR preview build was successful
Expand Down Expand Up @@ -58,9 +60,6 @@ jobs:
github_token: ${{ secrets.GITHUB_TOKEN }}
# Purge older files from a given PR
keep_files: false
# Accessible at http://docs.egi.eu/documentation/
# XXX use a different domain
# cname: docs.egi.eu
# Branch to push to
publish_branch: pr_previews
# Source directory
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ name: Lint
on:
pull_request:

permissions: read-all

jobs:
super-lint:
name: Lint with Super-Linter
Expand Down
122 changes: 122 additions & 0 deletions .github/workflows/mega-linter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
---
# MegaLinter GitHub Action configuration file
# More info at https://megalinter.io
name: MegaLinter

on:
# Trigger mega-linter at every push. Action will also be visible from Pull Requests to main
push:
pull_request:
branches: [main]

permissions: read-all

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
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: pull_request

concurrency:
group: ${{ github.ref }}-${{ github.workflow }}
cancel-in-progress: true

jobs:
megalinter:
name: MegaLinter
runs-on: ubuntu-latest
permissions:
# Give the default GITHUB_TOKEN write permission to commit and push, comment issues & post new PR
# Remove the ones you do not need
contents: read
issues: write
pull-requests: write
steps:
# Git Checkout
- name: Checkout Code
uses: actions/checkout@v4
with:
token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
# If you use VALIDATE_ALL_CODEBASE = true, you can remove this line to improve performances
fetch-depth: 0

# MegaLinter
- name: MegaLinter
id: ml
# You can override MegaLinter flavor used to have faster performances
# More info at https://megalinter.io/flavors/
uses: oxsecurity/megalinter/flavors/documentation@v8
env:
# All available variables are described in documentation
# https://megalinter.io/configuration/
# 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
VALIDATE_ALL_CODEBASE: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# ADD YOUR CUSTOM ENV VARIABLES HERE OR DEFINE THEM IN A FILE .mega-linter.yml AT THE ROOT OF YOUR REPOSITORY
DISABLE: COPYPASTE
DISABLE_LINTERS: REPOSITORY_GRYPE,REPOSITORY_TRIVY,REPOSITORY_TRUFFLEHOG,SPELL_CSPELL
# Scan only changes in PR, otherwise scan everything
REPOSITORY_GITLEAKS_PR_COMMITS_SCAN: ${{ github.event_name == 'pull_request' }}

# Upload MegaLinter artifacts
- name: Archive production artifacts
if: success() || failure()
uses: actions/upload-artifact@v4
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
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')
uses: peter-evans/create-pull-request@v6
with:
token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
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 "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')
uses: stefanzweifel/git-auto-commit-action@v4
with:
branch: ${{ github.event.pull_request.head.ref || github.head_ref || github.ref }}
commit_message: "[MegaLinter] Apply linters fixes"
commit_user_name: egibot
commit_user_email: [email protected]
2 changes: 2 additions & 0 deletions .github/workflows/spelling.yml
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,8 @@ on:
types:
- "created"

permissions: read-all

jobs:
spelling:
name: Check Spelling
Expand Down
2 changes: 2 additions & 0 deletions .lycheeignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
https://docs.egi.eu/documentation/*
https://megalinter.io/*
Loading