| git-cliff(1) | General Commands Manual | git-cliff(1) |
نام (NAME)
git-cliff - ابزاری با قابلیت شخصی‌سازی بالا برای تولید گزارش تغییرات (changelog)
خلاصه دستور (SYNOPSIS)
git-cliff [-h|--help] [-V|--version] [-v|--verbose]... [-i|--init] [--templates-dir] [--list-templates] [-c|--config] [--config-url] [-w|--workdir] [-r|--repository] [--include-path] [--exclude-path] [--tag-pattern] [--with-commit] [--with-tag-message] [--skip-tags] [--ignore-tags] [--count-tags] [--limit-tags] [--skip-commit] [-p|--prepend] [-o|--output] [-t|--tag] [--bump] [--bumped-version] [-b|--body] [--body-file] [-l|--latest] [--current] [-u|--unreleased] [--topo-order] [--use-branch-tags] [--no-exec] [-x|--context] [--from-context] [-s|--strip] [--sort] [--github-token] [--github-repo] [--gitlab-token] [--gitlab-repo] [--gitea-token] [--gitea-repo] [--bitbucket-token] [--bitbucket-repo] [--http-timeout] [--use-native-tls] [--offline] [RANGE]
توضیحات (DESCRIPTION)
ابزاری با قابلیت شخصی‌سازی بالا برای تولید گزارش تغییرات (changelog) از تاریخچه گیت.
فلگ‌ها (FLAGS)
- -h, --help
- چاپ اطلاعات راهنما
- -V, --version
- چاپ اطلاعات نسخه
- -v, --verbose
- افزایش سطح جزئیات گزارش‌ها
- --list-templates
- چاپ نام قالب‌های در دسترس (تعبیه‌شده و تعریف‌شده توسط کاربر)
- --bumped-version
- چاپ نسخه ارتقایافته برای تغییرات منتشرنشده
- -l, --latest
- پردازش کامیت‌ها با شروع از آخرین برچسب (tag)
- --current
- پردازش کامیت‌های متعلق به برچسب جاری
- -u, --unreleased
- پردازش کامیت‌هایی که به هیچ برچسبی تعلق ندارند
- --topo-order
- مرتب‌سازی توپولوژیک برچسب‌ها
- --use-branch-tags
- تنها شامل شدن برچسب‌های متعلق به شاخه جاری
- --no-exec
- غیرفعال کردن اجرای دستورهای خارجی
- -x, --context
- چاپ بافتار (context) گزارش تغییرات در قالب JSON
- --use-native-tls
- بارگذاری گواهی‌های TLS از مخزن گواهی‌های بومی سیستم
گزینه‌ها (OPTIONS)
- -i, --init [<CONFIG>]
- نوشتن فایل پیکربندی پیش‌فرض در cliff.toml
- --templates-dir <PATH>
- تنظیم دایرکتوری جستجوی قالب‌های سفارشی برای `--init`.
یک قالب تعریف‌شده توسط کاربر بر قالبی تعبیه‌شده با همان نام اولویت داشته و جایگزین آن می‌شود.
- -c, --config <PATH>
- تنظیم فایل پیکربندی.
در صورت مشخص نشدن، پیکربندی به‌طور خودکار شناسایی می‌شود (ابتدا در پروژه `cliff.toml` / `.cliff.toml` / `.config/cliff.toml` و سپس دایرکتوری پیکربندی کاربر)، و در غیر این صورت به پیش‌فرض تعبیه‌شده برمی‌گردد.
- --config-url <URL>
- تنظیم URL برای فایل پیکربندی
- -w, --workdir <PATH>
- تنظیم دایرکتوری کاری
- -r, --repository <PATH>...
- تنظیم مخزن گیت
- --include-path <PATTERN>
- تنظیم الگو برای مسیرهایی که کامیت‌های مربوط به آن‌ها گنجانده می‌شوند
- --exclude-path <PATTERN>
- تنظیم الگو برای مسیرهایی که کامیت‌های مربوط به آن‌ها مستثنی می‌شوند
- --tag-pattern <PATTERN>
- تنظیم عبارت باقاعده (regex) برای تطبیق با برچسب‌های گیت
- --with-commit <MSG>
- تنظیم پیام‌های کامیت سفارشی برای گنجاندن در گزارش تغییرات
- --with-tag-message [<MSG>]
- تنظیم پیام سفارشی برای آخرین انتشار (release)
- --skip-tags <PATTERN>
- تنظیم برچسب‌هایی که باید در گزارش تغییرات نادیده گرفته و رد شوند
- --ignore-tags <PATTERN>
- تنظیم برچسب‌هایی که در گزارش تغییرات نادیده گرفته می‌شوند
- --count-tags <PATTERN>
- تنظیم برچسب‌هایی که باید در گزارش تغییرات شمرده شوند
- --limit-tags <N>
- محدود کردن تعداد برچسب‌ها برای پردازش
- --skip-commit <SHA1>
- تنظیم کامیت‌هایی که در گزارش تغییرات رد می‌شوند
- -p, --prepend [<PATH>]
- الحاق موارد جدید به ابتدای فایل گزارش تغییرات داده‌شده
- -o, --output [<PATH>]
- نوشتن خروجی در فایل مشخص‌شده
- -t, --tag <TAG>
- تنظیم برچسب برای آخرین نسخه
- --bump [<BUMP>]
- ارتقای نسخه برای تغییرات منتشرنشده؛ به‌صورت اختیاری با نسخه مشخص‌شده
- -b, --body <TEMPLATE>
- تنظیم قالب برای بدنه گزارش تغییرات
- --body-file <PATH>
- خواندن قالب بدنه گزارش تغییرات از یک فایل
- --from-context <PATH>
- تولید گزارش تغییرات از یک بافتار JSON
- -s, --strip <PART>
- حذف
بخش‌های
مشخص‌شده
از گزارش
تغییرات
مقادیر ممکن:
- header
- footer
- all
- --sort <SORT> [پیش‌فرض: oldest]
- تنظیم نحوه
مرتب‌سازی
کامیت‌ها
در داخل
بخش‌ها
مقادیر ممکن:
- oldest
- newest
گزینه‌های دوردست (REMOTE OPTIONS)
- --github-token <TOKEN>
- تنظیم توکن API گیت‌هاب (GitHub)
- --github-repo <OWNER/REPO>
- تنظیم مخزن گیت‌هاب
- --gitlab-token <TOKEN>
- تنظیم توکن API گیت‌لب (GitLab)
- --gitlab-repo <OWNER/REPO>
- تنظیم مخزن گیت‌لب
- --gitea-token <TOKEN>
- تنظیم توکن API گیتی (Gitea)
- --gitea-repo <OWNER/REPO>
- تنظیم مخزن گیتی
- --bitbucket-token <TOKEN>
- تنظیم توکن API بیت‌باکت (Bitbucket)
- --bitbucket-repo <OWNER/REPO>
- تنظیم مخزن بیت‌باکت
- --http-timeout <SECS>
- تنظیم مهلت زمانی HTTP برای درخواست‌های فراداده از راه دور بر حسب ثانیه
- --offline
- غیرفعال کردن دسترسی شبکه برای مخازن دوردست
آرگومان‌ها (ARGS)
- [RANGE]
- تنظیم بازه کامیت‌ها برای پردازش
نسخه (VERSION)
v2.14.1
نویسندگان (AUTHORS)
مشارکت‌کنندگان git-cliff <git-cliff@protonmail.com>
همچنین ببینید (SEE ALSO)
| git-cliff 2.14.1 |