Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add GitHub Actions workflow for linting YAML files #11493

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Add GitHub Actions workflow for linting YAML files #11493

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3a8f9ea
Add GitHub Actions workflow for linting YAML files
KenEkanem Oct 21, 2024
6089eb7
chore: switch to actionlint for workflow file linting
KenEkanem Oct 27, 2024
420b4a8
chore(docker): specify version for `rhysd/actionlint` to ensure stabi…
KenEkanem Oct 29, 2024
115372d
chore(renovate): add package rule for `rhysd/actionlint` Docker image…
KenEkanem Oct 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .github/workflows/lint-workflow-files.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Lint GitHub Workflow YAML Files

on:
pull_request:
paths:
- '.github/workflows/*.yml'
- '.github/workflows/*.yaml'

jobs:
lint:
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Lint GitHub Workflow YAML Files with Docker
run: |
docker run --rm -v "${{ github.workspace }}:/repo" --workdir /repo rhysd/actionlint:latest -color .github/workflows/*.yml .github/workflows/*.yaml
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this use a specific version rather than latest to prevent the build from suddenly breaking with an unexpected change in a new release?

(ideally, the version should also be auto-upgraded with a renovate PR)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right using a specific version will ensure stability. I will update that. thanks

Copy link
Author

@KenEkanem KenEkanem Oct 29, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes made here 420b4a8 and 115372d


- name: Reminder to Address Linting Errors
if: failure()
run: |
echo "⚠️ Please address all linting errors before merging this pull request."

Loading