Skip to content

Commit

Permalink
[feat] add workflow to lint and validate reusable workflows
Browse files Browse the repository at this point in the history
  • Loading branch information
AndyBoWu committed Apr 3, 2024
1 parent d03108d commit 0675dcd
Show file tree
Hide file tree
Showing 3 changed files with 86 additions and 0 deletions.
11 changes: 11 additions & 0 deletions .github/linters/.yamllint
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
extends: default

rules:
line-length: disable
new-lines:
type: unix
new-line-at-end-of-file:
level: warning
trailing-spaces:
level: warning
75 changes: 75 additions & 0 deletions .github/workflows/lint-validation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
name: Workflow Linting and Validation

on:
pull_request:
paths:
- '.github/workflows/**'
push:
branches:
- main
- master
paths:
- '.github/workflows/**'

jobs:
lint-and-validate:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1

- name: Linting workflow files
uses: ibiqlik/action-yamllint@2576378a8e339169678f9939646ee3ee325e845c # v3.1.1
with:
config_file: .github/linters/.yamllint.yml

- name: Validate GitHub Actions workflows
id: validate
uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
with:
script: |
const fs = require('fs');
const path = require('path');
const { Octokit } = require("@octokit/core");
const octokit = new Octokit({ auth: process.env.GITHUB_TOKEN });
const workflowsDir = '.github/workflows';
let isValid = true;
let errorMessage = '';
fs.readdirSync(workflowsDir).forEach(file => {
const fullPath = path.join(workflowsDir, file);
console.log(`Validating ${fullPath}...`);
try {
// This is a simple placeholder for actual validation logic
// Actual validation should be implemented as per specific requirements
const fileContents = fs.readFileSync(fullPath, 'utf8');
if (!fileContents.includes('name')) {
throw new Error('Workflow must have a name');
}
} catch (error) {
isValid = false;
errorMessage += `Validation failed for ${file}: ${error.message}\n`;
}
});
if (!isValid) {
// Post a comment on the PR or commit if the validation fails
const context = github.context;
const issue_number = context.issue.number || context.payload.pull_request.number;
const owner = context.repo.owner;
const repo = context.repo.repo;
const comment = {
owner,
repo,
issue_number,
body: `🚨 Workflow Validation Error:\n\`\`\`\n${errorMessage}\n\`\`\``,
};
octokit.request('POST /repos/{owner}/{repo}/issues/{issue_number}/comments', comment);
throw new Error('One or more workflow validations failed.');
}
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

File renamed without changes.

0 comments on commit 0675dcd

Please sign in to comment.