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

fix: code-style description #431

Merged
merged 2 commits into from
Mar 21, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 6 additions & 5 deletions code-style/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,18 @@
name: >
Code style

description: >
description: |
This action evaluates the code quality of your project by using `pre-commit
<https://github.com/pre-commit/pre-commit/>`_. The action installs and runs
``pre-commit``. It is assumed that your project contains a
``.pre-commit-config.yaml`` file in the root directory. The action can also
be extended to lint docker files that are contained in the docker directory and the .devcontainer directory.
be extended to lint docker files that are contained in the docker directory
and the .devcontainer directory.

.. warning::
.. warning::

If docker lint is enabled and directories docker or .devcontainer exist,
the action will fail if it doesn't find a Dockerfile.
If docker lint is enabled and directories docker or .devcontainer exist,
the action will fail if it doesn't find a Dockerfile.


inputs:
Expand Down