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`.

       یک قالب تعریف‌شده توسط کاربر بر قالبی تعبیه‌شده با همان نام اولویت داشته
       و جایگزین آن می‌شود.
              همچنین می‌تواند از طریق متغیر محیطی GIT_CLIFF_TEMPLATES_DIR مشخص
              شود.

       -c, --config <PATH>
              تنظیم فایل پیکربندی.

       در صورت مشخص نشدن، پیکربندی به‌طور خودکار شناسایی می‌شود (ابتدا در پروژه
       `cliff.toml` / `.cliff.toml` / `.config/cliff.toml` و سپس دایرکتوری
       پیکربندی کاربر)، و در غیر این صورت به پیش‌فرض تعبیه‌شده برمی‌گردد.
              همچنین می‌تواند از طریق متغیر محیطی GIT_CLIFF_CONFIG مشخص شود.

       --config-url <URL>
              تنظیم URL برای فایل پیکربندی
              همچنین می‌تواند از طریق متغیر محیطی GIT_CLIFF_CONFIG_URL مشخص
              شود.

       -w, --workdir <PATH>
              تنظیم دایرکتوری کاری
              همچنین می‌تواند از طریق متغیر محیطی GIT_CLIFF_WORKDIR مشخص شود.

       -r, --repository <PATH>...
              تنظیم مخزن گیت
              همچنین می‌تواند از طریق متغیر محیطی GIT_CLIFF_REPOSITORY مشخص
              شود.

       --include-path <PATTERN>
              تنظیم الگو برای مسیرهایی که کامیت‌های مربوط به آن‌ها گنجانده
              می‌شوند
              همچنین می‌تواند از طریق متغیر محیطی GIT_CLIFF_INCLUDE_PATH مشخص
              شود.

       --exclude-path <PATTERN>
              تنظیم الگو برای مسیرهایی که کامیت‌های مربوط به آن‌ها مستثنی می‌شوند
              همچنین می‌تواند از طریق متغیر محیطی GIT_CLIFF_EXCLUDE_PATH مشخص
              شود.

       --tag-pattern <PATTERN>
              تنظیم عبارت باقاعده (regex) برای تطبیق با برچسب‌های گیت
              همچنین می‌تواند از طریق متغیر محیطی GIT_CLIFF_TAG_PATTERN مشخص
              شود.

       --with-commit <MSG>
              تنظیم پیام‌های کامیت سفارشی برای گنجاندن در گزارش تغییرات
              همچنین می‌تواند از طریق متغیر محیطی GIT_CLIFF_WITH_COMMIT مشخص
              شود.

       --with-tag-message [<MSG>]
              تنظیم پیام سفارشی برای آخرین انتشار (release)
              همچنین می‌تواند از طریق متغیر محیطی GIT_CLIFF_WITH_TAG_MESSAGE
              مشخص شود.

       --skip-tags <PATTERN>
              تنظیم برچسب‌هایی که باید در گزارش تغییرات نادیده گرفته و رد شوند
              همچنین می‌تواند از طریق متغیر محیطی GIT_CLIFF_SKIP_TAGS مشخص شود.

       --ignore-tags <PATTERN>
              تنظیم برچسب‌هایی که در گزارش تغییرات نادیده گرفته می‌شوند
              همچنین می‌تواند از طریق متغیر محیطی GIT_CLIFF_IGNORE_TAGS مشخص
              شود.

       --count-tags <PATTERN>
              تنظیم برچسب‌هایی که باید در گزارش تغییرات شمرده شوند
              همچنین می‌تواند از طریق متغیر محیطی GIT_CLIFF_COUNT_TAGS مشخص
              شود.

       --limit-tags <N>
              محدود کردن تعداد برچسب‌ها برای پردازش
              همچنین می‌تواند از طریق متغیر محیطی GIT_CLIFF_LIMIT_TAGS مشخص
              شود.

       --skip-commit <SHA1>
              تنظیم کامیت‌هایی که در گزارش تغییرات رد می‌شوند
              همچنین می‌تواند از طریق متغیر محیطی GIT_CLIFF_SKIP_COMMIT مشخص
              شود.

       -p, --prepend [<PATH>]
              الحاق موارد جدید به ابتدای فایل گزارش تغییرات داده‌شده
              همچنین می‌تواند از طریق متغیر محیطی GIT_CLIFF_PREPEND مشخص شود.

       -o, --output [<PATH>]
              نوشتن خروجی در فایل مشخص‌شده
              همچنین می‌تواند از طریق متغیر محیطی GIT_CLIFF_OUTPUT مشخص شود.

       -t, --tag <TAG>
              تنظیم برچسب برای آخرین نسخه
              همچنین می‌تواند از طریق متغیر محیطی GIT_CLIFF_TAG مشخص شود.

       --bump [<BUMP>]
              ارتقای نسخه برای تغییرات منتشرنشده؛ به‌صورت اختیاری با نسخه
              مشخص‌شده

       -b, --body <TEMPLATE>
              تنظیم قالب برای بدنه گزارش تغییرات
              همچنین می‌تواند از طریق متغیر محیطی GIT_CLIFF_TEMPLATE مشخص شود.

       --body-file <PATH>
              خواندن قالب بدنه گزارش تغییرات از یک فایل

       --from-context <PATH>
              تولید گزارش تغییرات از یک بافتار JSON
              همچنین می‌تواند از طریق متغیر محیطی GIT_CLIFF_CONTEXT مشخص شود.

       -s, --strip <PART>
              حذف بخش‌های مشخص‌شده از گزارش تغییرات

              مقادیر ممکن:

                     • header

                     • footer

                     • all

       --sort <SORT> [پیش‌فرض: oldest]
              تنظیم نحوه مرتب‌سازی کامیت‌ها در داخل بخش‌ها

              مقادیر ممکن:

                     • oldest

                     • newest

گزینه‌های دوردست (REMOTE OPTIONS)
       --github-token <TOKEN>
              تنظیم توکن API گیت‌هاب (GitHub)
              همچنین می‌تواند از طریق متغیر محیطی GITHUB_TOKEN مشخص شود.

       --github-repo <OWNER/REPO>
              تنظیم مخزن گیت‌هاب
              همچنین می‌تواند از طریق متغیر محیطی GITHUB_REPO مشخص شود.

       --gitlab-token <TOKEN>
              تنظیم توکن API گیت‌لب (GitLab)
              همچنین می‌تواند از طریق متغیر محیطی GITLAB_TOKEN مشخص شود.

       --gitlab-repo <OWNER/REPO>
              تنظیم مخزن گیت‌لب
              همچنین می‌تواند از طریق متغیر محیطی GITLAB_REPO مشخص شود.

       --gitea-token <TOKEN>
              تنظیم توکن API گیتی (Gitea)
              همچنین می‌تواند از طریق متغیر محیطی GITEA_TOKEN مشخص شود.

       --gitea-repo <OWNER/REPO>
              تنظیم مخزن گیتی
              همچنین می‌تواند از طریق متغیر محیطی GITEA_REPO مشخص شود.

       --bitbucket-token <TOKEN>
              تنظیم توکن API بیت‌باکت (Bitbucket)
              همچنین می‌تواند از طریق متغیر محیطی BITBUCKET_TOKEN مشخص شود.

       --bitbucket-repo <OWNER/REPO>
              تنظیم مخزن بیت‌باکت
              همچنین می‌تواند از طریق متغیر محیطی BITBUCKET_REPO مشخص شود.

       --http-timeout <SECS>
              تنظیم مهلت زمانی HTTP برای درخواست‌های فراداده از راه دور بر حسب
              ثانیه
              همچنین می‌تواند از طریق متغیر محیطی GIT_CLIFF_HTTP_TIMEOUT مشخص
              شود.

       --offline
              غیرفعال کردن دسترسی شبکه برای مخازن دوردست
              همچنین می‌تواند از طریق متغیر محیطی GIT_CLIFF_OFFLINE مشخص شود.

آرگومان‌ها (ARGS)
       [RANGE]
              تنظیم بازه کامیت‌ها برای پردازش

نسخه (VERSION)
       v2.14.1

نویسندگان (AUTHORS)
       مشارکت‌کنندگان git-cliff <git-cliff@protonmail.com>

همچنین ببینید (SEE ALSO)
       git(1)

       <https://git-cliff.org>

                               git-cliff 2.14.1                   git-cliff(1)