Skip to content

New yaml linter for GHA #103

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.

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

Closed
wants to merge 1 commit into from
Closed

New yaml linter for GHA #103

wants to merge 1 commit into from

Conversation

addshore
Copy link
Owner

@addshore addshore commented May 7, 2025

No description provided.

@addshore addshore requested a review from Copilot May 7, 2025 21:47
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the GitHub Actions workflow to use a new YAML linter by switching from the sdesbure/yaml-lint-action to github/super-linter.

  • Replaces a dedicated YAML lint action with Super Linter configured for YAML.
  • Sets environment variables (VALIDATE_YAML, DEFAULT_WORKSPACE, GITHUB_TOKEN) for the linter.

uses: github/super-linter@v5
env:
VALIDATE_YAML: true
Copy link
Preview

Copilot AI May 7, 2025

Choose a reason for hiding this comment

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

Switching to GitHub Super Linter may enable additional lint checks beyond YAML files. If only YAML linting is intended, consider adjusting the Super Linter configuration to restrict linting to YAML files.

Suggested change
VALIDATE_YAML: true
VALIDATE_YAML: true
VALIDATE_ALL_CODEBASE: false

Copilot uses AI. Check for mistakes.

- name: Lint YAML files
uses: github/super-linter@v5
Copy link
Preview

Copilot AI May 7, 2025

Choose a reason for hiding this comment

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

[nitpick] Consider adding a comment or documentation note that explains the purpose of setting DEFAULT_WORKSPACE, so that future maintainers are clear why this environment variable is explicitly declared.

Suggested change
uses: github/super-linter@v5
uses: github/super-linter@v5
# The DEFAULT_WORKSPACE environment variable specifies the workspace directory
# for the super-linter action. It ensures the linter operates within the correct
# context of the repository.

Copilot uses AI. Check for mistakes.

@addshore
Copy link
Owner Author

Well, the YAML is on wiki now...

@addshore addshore closed this May 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant