systemd/.github/workflows/linter.yml

---
# vi: ts=2 sw=2 et:
# SPDX-License-Identifier: LGPL-2.1-or-later
# https://github.com/marketplace/actions/super-linter
name: Lint Code Base

on:
  pull_request:
    branches:
      - main
      - v[0-9]+-stable

permissions:
  contents: read

jobs:
  build:
    name: Lint Code Base
    runs-on: ubuntu-latest
    concurrency:
      group: ${{ github.workflow }}-${{ github.ref }}
      cancel-in-progress: true

    steps:
      - name: Repo checkout
        uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579
        with:
          # We need a full repo clone
          fetch-depth: 0

      - name: Lint Code Base
        uses: github/super-linter/slim@b8641364ca9a79b3cf07f3c4c59a82709cd39094
        env:
          DEFAULT_BRANCH: main
          MULTI_STATUS: false
          # Excludes:
          #   - man/.* - all snippets in man pages (false positives due to
          #              missing shebangs)
          #   - kernel-install/.* - false-positives for dropins (and I'm afraid
          #                         to touch kernel-install)
          #   - .*\.(in|SKELETON) - all template/skeleton files
          #   - tools/coverity\.sh - external file (with some modifications)
          FILTER_REGEX_EXCLUDE: .*/(man/.*|src/kernel-install/.*|.*\.(in|SKELETON)|tools/coverity\.sh)$
          VALIDATE_ALL_CODEBASE: false
          VALIDATE_BASH: true
          VALIDATE_GITHUB_ACTIONS: true
ci: introduce Super-Linter for shell scripts See: https://github.com/marketplace/actions/super-linter 2021-09-29 23:08:51 +03:00			`---`
github: use the same headers on yaml files Also adjust the mention of location of mkosi files, follow-up for d55ad7fe96eb1edf438a7a41a465723bd29d4b10. 2021-10-01 13:09:20 +03:00			`# vi: ts=2 sw=2 et:`
ci: use LGPLv2+ for all our ci configuration 2021-10-01 13:10:22 +03:00			`# SPDX-License-Identifier: LGPL-2.1-or-later`
ci: introduce Super-Linter for shell scripts See: https://github.com/marketplace/actions/super-linter 2021-09-29 23:08:51 +03:00			`# https://github.com/marketplace/actions/super-linter`
			`name: Lint Code Base`

			`on:`
			`pull_request:`
			`branches:`
			`- main`
ci: run the unit_tests and mkosi jobs on stable branches as well To provide more coverage for the systemd-stable repo. See: https://github.com/systemd/systemd-stable/issues/24 2021-11-12 19:37:15 +03:00			`- v[0-9]+-stable`
ci: introduce Super-Linter for shell scripts See: https://github.com/marketplace/actions/super-linter 2021-09-29 23:08:51 +03:00
ci: mimic the "restricted" mode Judging by https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token it should be enough to grant the "read contents" permission to most of our actions. The "read metadata" permission is set impliciclty somewhere and can't be set via the "permissions" setting: ``` The workflow is not valid. .github/workflows/linter.yml (Line: 14, Col: 3): Unexpected value 'metadata' ``` 2021-11-14 01:34:04 +03:00			`permissions:`
			`contents: read`
ci: tighten several GHActions a bit more with https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#permissions 2021-11-13 17:40:20 +03:00
ci: introduce Super-Linter for shell scripts See: https://github.com/marketplace/actions/super-linter 2021-09-29 23:08:51 +03:00			`jobs:`
			`build:`
			`name: Lint Code Base`
			`runs-on: ubuntu-latest`
ci: cancel previous jobs on ref update Let's save the environment (and reduce the number of jobs in GH Actions queues) by cancelling old jobs on a ref update (force push). See: https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#concurrency 2021-11-10 18:45:12 +03:00			`concurrency:`
			`group: ${{ github.workflow }}-${{ github.ref }}`
			`cancel-in-progress: true`
ci: introduce Super-Linter for shell scripts See: https://github.com/marketplace/actions/super-linter 2021-09-29 23:08:51 +03:00
			`steps:`
			`- name: Repo checkout`
build(deps): bump actions/checkout from 2 to 2.4.0 Bumps [actions/checkout](https://github.com/actions/checkout) from 2 to 2.4.0. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v2...ec3a7ce113134d7a93b817d10a8272cb61118579) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> 2021-11-13 12:36:24 +03:00			`uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579`
ci: introduce Super-Linter for shell scripts See: https://github.com/marketplace/actions/super-linter 2021-09-29 23:08:51 +03:00			`with:`
			`# We need a full repo clone`
			`fetch-depth: 0`

			`- name: Lint Code Base`
ci: use the 'slim' version of Super-Linter The 'slim' version drops certain storage-heavy linters[0] which we don't use anyway, so let's make the job a bit faster by downloading and using a smaller image. [0] https://github.com/github/super-linter#slim-image 2022-02-13 16:54:51 +03:00			`uses: github/super-linter/slim@b8641364ca9a79b3cf07f3c4c59a82709cd39094`
ci: introduce Super-Linter for shell scripts See: https://github.com/marketplace/actions/super-linter 2021-09-29 23:08:51 +03:00			`env:`
			`DEFAULT_BRANCH: main`
ci: explicitly disable multi-status for Super-Linter to, hopefully, get rid of the following error: ``` 2022-02-13 13:32:12 [ERROR] Failed to get [GITHUB_TOKEN]! 2022-02-13 13:32:12 [ERROR] [] 2022-02-13 13:32:12 [ERROR] Please set a [GITHUB_TOKEN] from the main workflow environment to take advantage of multiple status reports! ``` 2022-02-13 16:59:08 +03:00			`MULTI_STATUS: false`
ci: introduce Super-Linter for shell scripts See: https://github.com/marketplace/actions/super-linter 2021-09-29 23:08:51 +03:00			`# Excludes:`
			`# - man/.* - all snippets in man pages (false positives due to`
			`# missing shebangs)`
			`# - kernel-install/.* - false-positives for dropins (and I'm afraid`
			`# to touch kernel-install)`
			`# - .*\.(in\|SKELETON) - all template/skeleton files`
			`# - tools/coverity\.sh - external file (with some modifications)`
			`FILTER_REGEX_EXCLUDE: ./(man/.\|src/kernel-install/.\|.\.(in\|SKELETON)\|tools/coverity\.sh)$`
			`VALIDATE_ALL_CODEBASE: false`
			`VALIDATE_BASH: true`
ci: validate actions and fix actionlint warnings some actions like Coverity and CFLite aren't run on every PR so to make sure they are more or less fine when they are changed it makes sense to at least check them with superlinter/actionlint: https://github.com/rhysd/actionlint The following warnings were fixed along the way: ``` .github/workflows/mkosi.yml:55:7: shellcheck reported issue in this script: SC2086:info:6:14: Double quote to prevent globbing and word splitting [shellcheck] \| 55 \| run: \| \| ^~~~ .github/workflows/mkosi.yml:55:7: shellcheck reported issue in this script: SC2046:warning:6:40: Quote this to prevent word splitting [shellcheck] \| 55 \| run: \| \| ^~~~ .github/workflows/mkosi.yml:55:7: shellcheck reported issue in this script: SC2006:style:6:40: Use $(...) notation instead of legacy backticked `...` [shellcheck] \| 55 \| run: \| \| ^~~~ ``` ``` .github/workflows/coverity.yml:31:9: shellcheck reported issue in this script: SC2086:info:1:93: Double quote to prevent globbing and word splitting [shellcheck] \| 31 \| run: echo "COVERITY_SCAN_NOTIFICATION_EMAIL=$(git log -1 ${{ github.sha }} --pretty=\"%aE\")" >> $GITHUB_ENV \| ^~~~ ``` 2022-02-08 20:34:10 +03:00			`VALIDATE_GITHUB_ACTIONS: true`