infrastructure-actions/.github/workflows/check-project-actions.yml at 70b55cfd9f4ebc9dc6e8e38198d58708d173c811 · apache/infrastructure-actions · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.
#

# Workflow to be called from ASF project repository workflows to check
# whether the GitHub actions referenced in GitHub workflows (`.github/workflows`) and
# composite actions (`.github/actions`) are approved.
#
# The README.md of ASF Infrastructure Actions repository https://github.com/apache/infrastructure-actions
# contains usage instructions.
#
# See: ASF Infrastructure GitHub Actions Policy: https://infra.apache.org/github-actions-policy.html


name: Check Actions Usage
on:
  workflow_call:
    inputs:
      repository:
        required: false
        description: |
          Optional, the `repository` parameter for `actions/checkout`.
          If not specified, the default is to use the repository of the calling workflow.
          See https://github.com/actions/checkout?tab=readme-ov-file#usage for details.
        type: string
      ref:
        required: false
        description: |
          Optional, the `ref` parameter for `actions/checkout`
          If not specified, the default is to use the repository of the calling workflow.
          See https://github.com/actions/checkout?tab=readme-ov-file#usage for details.
        type: string
      fetch-depth:
        required: false
        description: |
          Optional, the `fetch-depth` parameter for `actions/checkout`.
          See https://github.com/actions/checkout?tab=readme-ov-file#usage for details.
        type: number
        default: 1
      submodules:
        required: false
        description: |
          Optional, the `submodules` parameter for `actions/checkout`.
          See https://github.com/actions/checkout?tab=readme-ov-file#usage for details.
        type: boolean
        default: false

jobs:
  check-project-actions:
    runs-on: ubuntu-latest
    permissions:
      contents: read
    steps:
      - name: "Checkout apache/infrastructure-actions"
        uses: actions/checkout@v2
        with:
          repository: 'apache/infrastructure-actions'
          ref: 'main'

      - name: "Checkout repository to be checked"
        uses: actions/checkout@v2
        with:
          repository: '${{ inputs.repository }}'
          ref: ${{ inputs.ref }}
          fetch-depth: ${{ inputs.fetch-depth }}
          submodules: ${{ inputs.submodules }}
          path: repository-to-be-checked

      - run: pip install ruyaml

      - name: Check allowed actions usage
        shell: python
        run: |
          import sys
          sys.path.append("./gateway/")

          import check_repository_actions as c
          c.check_project_actions('./repository-to-be-checked', './approved_patterns.yml')