headsnet/grumphp-gitlab-lint

在 GrumPHP 预提交钩子中清理您的 Gitlab CI 配置

v0.1.4 2023-11-29 10:21 UTC

This package is auto-updated.

Last update: 2024-08-29 11:53:29 UTC


README

Github Actions Installs Packagist

GrumPHP Gitlab Lint

在 GrumPHP 预提交钩子中清理您的 Gitlab CI 配置

安装

支持 Symfony 5.3 及以上版本,以及 PHP 7.4 或更高版本。

使用 Composer 安装

composer require --dev headsnet/grumphp-gitlab-lint

使用

# grumphp.yml
grumphp:
    tasks:
        gitlab_lint:
            api_token:   '%env(GITLAB_TOKEN)%'   # required
            gitlab_file: .gitlab-ci.yml          # optional
            gitlab_url:  gitlab.com              # optional
    extensions:
        - Headsnet\GrumPHP\GitlabLint\Loader

API 令牌(必需)

您必须创建一个 API 令牌以进行认证。令牌必须具有 api 访问权限。

您可以使用 '%env(YOUR_ENV_VAR_NAME)%' 语法导入环境变量,这样您就不必将令牌提交到您的存储库中。

Gitlab 文件(可选)

可选参数,用于指定要清理的替代文件。默认为项目根目录中的 .gitlab-ci.yml

Gitlab URL(可选)

您的本地 Gitlab 实例的自定义位置。

贡献

欢迎贡献。请提交每个 pull request 包含一个修复/特性的修复请求。

Composer 脚本已为您配置好

> composer test       # Run test suite
> composer cs         # Run coding standards checks
> composer cs-fix     # Fix coding standards violations
> composer static     # Run static analysis with Phpstan

许可证

此代码在 MIT 许可下发布。请参阅 LICENSE 文件以获取更多信息。