Skip to content

Commit d8e8b63

Browse files
neilimeneilime
committed
feat(linter-actions): supports single GitHub Action
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
1 parent 6b5b43e commit d8e8b63

5 files changed

Lines changed: 137 additions & 46 deletions

File tree

‎.github/workflows/linter-actions.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,12 @@ jobs:
6666
6767
<!-- start inputs -->
6868
69-
| **Input** | **Description** | **Default** | **Type** | **Required** |
70-
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------ | --------------------------------------- | -------- | ------------ |
71-
| **<code>runs-on</code>** | Json array of runner(s) to use. See <https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job>. | <code>["ubuntu-latest"]<code> | `string` | **false** |
72-
| **<code>directories</code>** | List of directories to lint. | <code>.github/workflows\nactions</code> | `string` | **false** |
69+
| **Input** | **Description** | **Default** | **Type** | **Required** |
70+
| ----------------------------- | ------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------- | --------- | ------------ |
71+
| **<code>runs-on</code>** | Json array of runner(s) to use. See <https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job>. | <code>["ubuntu-latest"]<code> | `string` | **false** |
72+
| **<code>lint-all</code>** | Run linter on all files, not just the changed ones. | <code>github.event_name != 'pull_request'</code> | `boolean` | **false** |
73+
| **<code>action-files</code>** | List of files or directories where GitHub Actions are defined. Supports glob patterns. | <code>./action.yml\n./.github/workflows/\*\*/\*.yml\n./actions/\*\*/\*.yml</code> | `string` | **false** |
74+
| **<code>linter-env</code>** | Environment variables in multilines format "key=value" to pass to the linter. See [linter](./linter.md). | <code></code> | `string` | **false** |
7375

7476
<!-- end inputs -->
7577

‎.github/workflows/linter-actions.yml‎

Lines changed: 120 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,24 @@ on:
1717
type: string
1818
default: '["ubuntu-latest"]'
1919
required: false
20-
directoriesInput:
21-
description: "List of directoriesInput to lint."
20+
lint-all:
21+
description: "Run linter on all files, not just the changed ones."
22+
type: boolean
23+
required: false
24+
default: ${{ github.event_name != 'pull_request' }}
25+
action-files:
26+
description: "List of files or directories where GitHub Actions are defined. Supports glob patterns."
2227
type: string
2328
default: |
24-
.github/workflows
25-
actions
29+
./action.yml
30+
./.github/workflows/**/*.yml
31+
./actions/**/*.yml
32+
linter-env:
33+
description: |
34+
Environment variables in multilines format "key=value" to pass to the linter.
35+
See [linter](./linter.md).
36+
type: string
37+
required: false
2638

2739
secrets:
2840
github-token:
@@ -61,55 +73,130 @@ jobs:
6173
runs-on: ${{ fromJson(inputs.runs-on) }}
6274
steps:
6375
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
76+
with:
77+
fetch-depth: "${{ inputs.lint-all && 1 || 0 }}"
78+
79+
- id: changed-files
80+
uses: tj-actions/changed-files@823fcebdb31bb35fdf2229d9f769b400309430d0 # v46.0.3
81+
if: ${{ inputs.lint-all == false }}
82+
with:
83+
files: ${{ inputs.action-files }}
84+
dir_names_exclude_current_dir: true
6485

6586
- id: get-files-to-lint
66-
uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
87+
uses: actions/github-script@e69ef5462fd455e02edcaf4dd7708eda96b9eda0 # v7.0.0
6788
with:
6889
script: |
6990
const fs = require("node:fs");
7091
const path = require("node:path");
7192
72-
const directoriesInput = ${{ toJson(inputs.directoriesInput) }};
73-
const directories = [];
93+
const changedFiles = ${{ toJSON(steps.changed-files.outputs.all_changed_and_modified_files) }};
7494
75-
for (const directory of directoriesInput.split("\n")) {
76-
let sanitizedDirectory = directory.trim();
77-
if (sanitizedDirectory === "") {
78-
continue;
79-
}
95+
let actionFiles = [];
96+
if (changedFiles !== null) {
97+
actionFiles = changedFiles.split(" ");
98+
} else {
99+
const actionFilesInput = ${{ toJson(inputs.action-files) }};
100+
101+
for (const actionFile of actionFilesInput.split("\n")) {
102+
let sanitizedActionFile = actionFile.trim();
103+
if (sanitizedActionFile === "") {
104+
continue;
105+
}
80106
81-
if (path.isAbsolute(sanitizedDirectory)) {
82-
// Ensure directory is within the workspace
83-
if (!sanitizedDirectory.startsWith(process.env.GITHUB_WORKSPACE)) {
84-
return core.setFailed(`Directory is not within the workspace: ${sanitizedDirectory}`);
107+
if (path.isAbsolute(sanitizedActionFile)) {
108+
// Ensure actionFile is within the workspace
109+
if (!sanitizedActionFile.startsWith(process.env.GITHUB_WORKSPACE)) {
110+
return core.setFailed(`Action file / directory is not within the workspace: ${sanitizedActionFile}`);
111+
}
112+
} else {
113+
sanitizedActionFile = path.join(process.env.GITHUB_WORKSPACE, sanitizedActionFile);
85114
}
86-
} else {
87-
sanitizedDirectory = path.join(process.env.GITHUB_WORKSPACE, sanitizedDirectory);
115+
actionFiles.push(sanitizedActionFile);
88116
}
89117
90-
// Ensure directory exists
91-
if (!fs.existsSync(sanitizedDirectory)) {
92-
core.setFailed(`Directory does not exist: ${sanitizedDirectory}`);
118+
if (actionFiles.length === 0) {
119+
return core.setFailed("No action files to lint.");
93120
}
94121
95-
directories.push(sanitizedDirectory);
96-
}
122+
async function getActionFiles(actionFile) {
123+
const globber = await glob.create(actionFile,{ matchactionFilesInput: false });
124+
return await globber.glob();
125+
}
126+
127+
actionFiles = (await Promise.all(actionFiles.map(getActionFiles)))
128+
.flat()
129+
.map((file) => path.relative(process.env.GITHUB_WORKSPACE, file));
97130
98-
if (directories.length === 0) {
99-
return core.setFailed("No directories to lint.");
131+
if (actionFiles.length === 0) {
132+
return core.setFailed("No action files to lint.");
133+
}
100134
}
101135
102-
async function getActionFiles(directory){
103-
const globber = await glob.create(`${directory}/**/*.yml`,{ matchdirectoriesInput: false });
104-
const matchingFiles = await globber.glob();
136+
const files = actionFiles.map((file) => path.relative(process.env.GITHUB_WORKSPACE, file));
105137
106-
return matchingFiles.map(matchingFile => path.relative(process.env.GITHUB_WORKSPACE, matchingFile));
107-
}
138+
const filesOutput = [...new Set(files)].join(" ").trim();
108139
109-
const files = await Promise.all(directories.map(getActionFiles));
110-
core.setOutput("files", files.flat().join(" ").trim());
140+
core.setOutput("files", filesOutput);
111141
112-
- uses: "docker://ghcr.io/sethvargo/ratchet:0.10.2@sha256:78f70ed0c85830a78bd9eeb265f49aa375d71887e4245aebc5da9c641d76b245" # v0.10.2
142+
- id: ratchet
143+
uses: "docker://ghcr.io/sethvargo/ratchet:0.10.2@sha256:78f70ed0c85830a78bd9eeb265f49aa375d71887e4245aebc5da9c641d76b245" # v0.10.2
113144
if: ${{ steps.get-files-to-lint.outputs.files }}
114145
with:
115146
args: "check ${{ steps.get-files-to-lint.outputs.files }}"
147+
148+
- if: ${{ failure() && steps.get-files-to-lint.outputs.files }}
149+
uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
150+
with:
151+
script: |
152+
const ratchetOutcome = ${{ toJSON(steps.ratchet.outcome) }};
153+
154+
if (ratchetOutcome !== "failure") {
155+
return;
156+
}
157+
158+
// FIXME: should retrieve ratchet error output. See https://github.com/sethvargo/ratchet/issues/103.
159+
const ratchetErrorsOutputs = ${{ toJSON(steps.ratchet.outputs.errors) }};
160+
if (!ratchetErrorsOutputs || ratchetErrorsOutputs.length === 0) {
161+
return;
162+
}
163+
164+
// Format the ratchet errors: found x unpinned refs: ...
165+
const unpinnedRefsError = /found (\d+) unpinned refs: (.*)/g.exec(ratchetErrorsOutputs[0]);
166+
if (!unpinnedRefsError) {
167+
return;
168+
}
169+
170+
const unpinnedRefs = JSON.parse(unpinnedRefsError[2]);
171+
172+
async function getFileErrors(file) {
173+
const fileContent = await fs.promises.readFile(file, "utf8");
174+
175+
const errors = [];
176+
177+
for(const unpinnedRef of unpinnedRefs) {
178+
if(fileContent.includes(unpinnedRef)) {
179+
errors.push(file);
180+
}
181+
}
182+
183+
return errors;
184+
}
185+
186+
const files = ${{ toJSON(steps.get-files-to-lint.outputs.files) }}.split(" ");
187+
188+
// Annotate file errors
189+
await Promise.all(files.map(async (file) => {
190+
const errors = await getFileErrors(file);
191+
if (errors.length === 0) {
192+
return;
193+
}
194+
195+
core.error(
196+
`Found ${errors.length} unpinned refs`,
197+
{
198+
title: `Unpinned refs: ${JSON.stringify(errors)}`,
199+
file: file
200+
}
201+
);
202+
}));

‎actions/checkout/action.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ inputs:
1111
default: "1"
1212
lfs:
1313
description: "Whether to download Git-LFS files. See [https://github.com/actions/checkout#usage](https://github.com/actions/checkout#usage)"
14-
default: false
14+
default: "false"
1515
token:
1616
description: |
1717
Token to use for checking out the repository instead of the default GITHUB_TOKEN.

‎actions/create-and-merge-pull-request/README.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,13 +61,13 @@ See [Allow GitHub Actions to create and approve pull requests](https://docs.gith
6161
6262
<!-- start inputs -->
6363
64-
| **Input** | **Description** | **Default** | **Required** |
65-
| --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | ------------ |
66-
| <code>github-token</code> | GitHub token for creating and merging pull request (permissions contents: write and pull-requests: write). See https://github.com/peter-evans/create-pull-request#action-inputs. | <code>${{ github.token }}</code> | **false** |
67-
| <code>branch</code> | The pull request branch name | | **true** |
68-
| <code>title</code> | The pull request title | | **true** |
69-
| <code>body</code> | The pull request body | | **true** |
70-
| <code>commit-message</code> | The commit message for the pull request | | **true** |
64+
| **Input** | **Description** | **Default** | **Required** |
65+
| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | ------------ |
66+
| <code>github-token</code> | GitHub token for creating and merging pull request (permissions contents: write and pull-requests: write). See <https://github.com/peter-evans/create-pull-request#action-inputs>. | <code>${{ github.token }}</code> | **false** |
67+
| <code>branch</code> | The pull request branch name | | **true** |
68+
| <code>title</code> | The pull request title | | **true** |
69+
| <code>body</code> | The pull request body | | **true** |
70+
| <code>commit-message</code> | The commit message for the pull request | | **true** |
7171
7272
<!-- end inputs -->
7373
<!-- start outputs -->

‎actions/create-and-merge-pull-request/action.yml‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ branding:
77

88
inputs:
99
github-token:
10-
description: "GitHub token for creating and merging pull request (permissions contents: write and pull-requests: write). See https://github.com/peter-evans/create-pull-request#action-inputs."
10+
description: |
11+
GitHub token for creating and merging pull request (permissions contents: write and pull-requests: write).
12+
See <https://github.com/peter-evans/create-pull-request#action-inputs>.
1113
default: ${{ github.token }}
1214
required: false
1315
branch:

0 commit comments

Comments
 (0)