github.com/jaylevin/jenkins-library@v1.230.4/resources/metadata/hadolintExecute.yaml (about)

     1  metadata:
     2    name: hadolintExecute
     3    description: Executes the Haskell Dockerfile Linter which is a smarter Dockerfile linter that helps you build [best practice](https://docs.docker.com/develop/develop-images/dockerfile_best-practices/) Docker images.
     4    longDescription: |-
     5      Executes the Haskell Dockerfile Linter which is a smarter Dockerfile linter that helps you build [best practice](https://docs.docker.com/develop/develop-images/dockerfile_best-practices/) Docker images.
     6      The linter is parsing the Dockerfile into an abstract syntax tree (AST) and performs rules on top of the AST.
     7  spec:
     8    inputs:
     9      secrets:
    10        - name: configurationCredentialsId
    11          type: jenkins
    12          description: Jenkins 'Username with password' credentials ID containing username/password for access to your remote configuration file.
    13      params:
    14        - name: configurationUrl
    15          type: string
    16          description: URL pointing to the .hadolint.yaml exclude configuration to be used for linting. Also have a look at `configurationFile` which could avoid central configuration download in case the file is part of your repository.
    17          mandatory: false
    18          scope:
    19            - PARAMETERS
    20            - STAGES
    21            - STEPS
    22          default: null
    23        - name: configurationUsername
    24          aliases:
    25            - name: username
    26          type: string
    27          description: The username to authenticate
    28          scope:
    29            - PARAMETERS
    30            - STAGES
    31            - STEPS
    32          secret: true
    33          resourceRef:
    34            - type: secret
    35              name: configurationCredentialsId
    36              param: username
    37            - type: vaultSecret
    38              name: hadolintConfigSecretName
    39              default: hadolintConfig
    40        - name: configurationPassword
    41          aliases:
    42            - name: password
    43          type: string
    44          description: The password to authenticate
    45          scope:
    46            - PARAMETERS
    47            - STAGES
    48            - STEPS
    49          secret: true
    50          resourceRef:
    51            - type: secret
    52              name: configurationCredentialsId
    53              param: password
    54            - type: vaultSecret
    55              name: hadolintConfigSecretName
    56              default: hadolintConfig
    57        - name: dockerFile
    58          aliases:
    59            - name: dockerfile
    60          type: string
    61          description: Dockerfile to be used for the assessment.
    62          mandatory: false
    63          scope:
    64            - GENERAL
    65            - PARAMETERS
    66            - STAGES
    67            - STEPS
    68          default: ./Dockerfile
    69        - name: configurationFile
    70          type: string
    71          description: Name of the configuration file used locally within the step. If a file with this name is detected as part of your repo downloading the central configuration via `configurationUrl` will be skipped. If you change the file's name make sure your stashing configuration also reflects this.
    72          mandatory: false
    73          scope:
    74            - PARAMETERS
    75            - STAGES
    76            - STEPS
    77          default: .hadolint.yaml
    78        - name: reportFile
    79          type: string
    80          description: Name of the result file used locally within the step.
    81          scope:
    82            - PARAMETERS
    83            - STAGES
    84            - STEPS
    85          default: hadolint.xml
    86        - name: customTlsCertificateLinks
    87          type: "[]string"
    88          description: "List of download links to custom TLS certificates. This is required to ensure trusted connections between Piper and the system where the configuration file is to be downloaded from."
    89          scope:
    90            - PARAMETERS
    91            - STAGES
    92            - STEPS
    93    containers:
    94      - name: hadolint
    95        image: hadolint/hadolint:latest-alpine