naoi / drupalorg-cli
与 Drupal.org 交互的命令行界面
dev-main
2023-04-18 22:25 UTC
Requires
- php: ^7.4 || ^8.0
- composer-runtime-api: ^2.0.0
- ext-dom: *
- ext-json: *
- consolidation/self-update: ^2.0
- dg/rss-php: ^1.2
- doctrine/cache: ^1.6
- guzzlehttp/guzzle: ^6.1 || ^7.3
- jolicode/jolinotif: ^2.3
- kevinrob/guzzle-cache-middleware: ^4
- klaussilveira/gitter: ^0.3.0
- psr/log: ^1.0
- symfony/cache: ^5.0 || ^6.0
- symfony/console: ^5.0 || ^6.0
- symfony/process: ^5.0 || ^6.0
Requires (Dev)
- phpstan/extension-installer: ^1.0
- phpstan/phpstan: ^1.0.0
- phpstan/phpstan-deprecation-rules: ^1.0.0
- phpstan/phpstan-strict-rules: ^1.0.0
- phpstan/phpstan-symfony: ^1.0.0
- phpunit/phpunit: ^9.5
- squizlabs/php_codesniffer: ^3.5
This package is auto-updated.
Last update: 2024-09-19 01:43:14 UTC
README
A command line tool for interfacing with Drupal.org. Uses the Drupal.org REST API.
需求
- PHP 7.4 或更高版本,支持 cURL
- Git - 目前需要用于应用和创建补丁。对于将补丁贡献回问题非常有用。
安装
手动安装
-
从 最新版本 下载
drupalorg.phar
文件。 -
将文件重命名为
drupalorg
,确保它可执行,并将其移动到 PATH 目录中(使用echo $PATH
查看选项)。 -
运行
drupalorg
并验证您是否可以看到可用命令列表。
通过 Composer 安装(已弃用)
使用以下命令通过 Composer 安装命令行工具
composer global require mglaman/drupalorg-cli
安装 (Bash) 完成支持
drupalorg
为所有命令提供完成支持,不包括选项。
要激活它,可以源代码或将其添加到系统范围的完成目录中,通常为 /etc/bash_completion.d/
。
在您的 .bashrc
(或 .profile
)中添加
source [...]/vendor/mglaman/drupalorg-cli/drupalorg-cli-completion.sh
更新
尚不支持自动更新。您需要手动下载新版本。
使用方法
使用 'list' 命令查看可用命令。
drupalorg list
命令
Available commands:
help Displays help for a command
list Lists commands
cache
cache:clear (cc) Clears caches
ci
drupalci
drupalci:list (ci:l) Lists test results for an issue
drupalci:watch (ci:w) Watches a Drupal CI job
issue
issue:apply Applies the latest patch from an issue.
issue:branch Creates a branch for the issue.
issue:interdiff Generate an interdiff for the issue from local changes.
issue:link Opens an issue
issue:patch Generate a patch for the issue from committed local changes.
maintainer
maintainer:issues (mi) Lists issues for a user, based on maintainer.
maintainer:release-notes (rn, mrn) Generate release notes.
project
project:issues (pi) Lists issues for a project.
project:kanban Opens project kanban
project:link Opens project page
project:release-notes (prn) View release notes for a release
project:releases Lists available releases
tci
travisci
travisci:list (tci:l) Lists Travis Ci builds for a Drupal project
travisci:watch (tci:w) Watches a Travis CI job
入门
处理项目问题
如果您想使用此工具生成可以贡献给 Drupal 项目的补丁,最好在项目的克隆仓库中工作。要获取克隆项目仓库的说明,请访问项目页面上的“版本控制”标签。
在我们要工作的项目目录中
drupalorg issue:apply [问题编号]
- 为给定的问题创建一个新分支,将问题上的最新补丁应用到新分支,然后在本地提交更改。drupalorg issue:patch [问题编号]
- 从已提交的本地更改创建给定问题的补丁。
贡献
从源代码安装和运行
- 克隆仓库
- 在 drupalorg-cli 目录中,运行
composer install
- 使用
./drupalorg
运行脚本