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.

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

Introduce actionlint job for linting GitHub Actions workflows #111

Merged
merged 3 commits into from
Oct 9, 2024

Conversation

tfrommen
Copy link
Contributor

@tfrommen tfrommen commented Oct 2, 2024

This is a suggestion to address #84, using the reusable lint-workflows workflow, which under the hood is based on actionlint.

I kept the workflow trigger the same as for code quality.

@tfrommen tfrommen requested a review from a team as a code owner October 2, 2024 11:27
@swissspidy
Copy link
Member

Thanks for the PR, @tfrommen!

I don't think we'd want to use inpsyde/reusable-workflows/.github/workflows/lint-workflows.yml@main here, but either add those two steps directly to the repo or use the suggested steps from the projects' example (with problem matchers).

Also, if we move this to reusable-code-quality.yml, then we can automatically use this workflow here and in all other repos.

@tfrommen
Copy link
Contributor Author

tfrommen commented Oct 2, 2024

Hi @swissspidy, happy to change things. What should it be?

@swissspidy
Copy link
Member

After sleeping on it, let's go with the suggested integration as per the project's examples, and do that in reusable-code-quality.yml

@tfrommen
Copy link
Contributor Author

tfrommen commented Oct 3, 2024

@swissspidy done. I added the shellcheck integration, considering that there are some bash/shell scripts included in this repository already, and I assume more in others.

@tfrommen tfrommen changed the title Introduce lint-workflows workflow Introduce actionlint job for linting GitHub Actions workflows Oct 4, 2024
Copy link
Member

@swissspidy swissspidy left a comment

Choose a reason for hiding this comment

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

Lets' try this out

@swissspidy swissspidy merged commit 7bcc6fb into wp-cli:main Oct 9, 2024
7 checks passed
@jrfnl
Copy link
Contributor

jrfnl commented Oct 13, 2024

I added the shellcheck integration, considering that there are some bash/shell scripts included in this repository already, and I assume more in others.

I get the impression that shellcheck is now disabled instead... ?

From actionlint -h:

Flags:
  -shellcheck string
        Command name or file path of "shellcheck" external command. If empty, shellcheck integration will be disabled (default "shellcheck")

uses: actions/checkout@v4

- name: Add problem matcher
run: |
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggestion:

        if: ${{ github.event_name == 'pull_request' }}

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.

3 participants