[Feature] Add composable calculate and output commands to the src CLI

Đang mở
#5,398 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
csharp, git
Lĩnh vực
backend, cli

Hướng nghiên cứu

Start with src/GitVersion.App/ArgumentParser.cs, Arguments.cs, and GitVersionApp.cs to trace command parsing and dispatch, then read GitVersionOutputTool.cs and VersionVariableSerializer.cs for existing output behavior. Run the relevant parser and output checks as you map the calculation and snapshot paths. Done means both commands work in a two-process pipeline, validate input before side effects, preserve existing root behavior, and meet the listed acceptance criteria.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

feature

Problem

The established src/ CLI has a POSIX/System.CommandLine parser and the v7 calculation/output configuration layout, but it still calculates versions and applies outputs through one root invocation. It has no calculate or output subcommands.

In his September 7 review of #5160, @asbjornu wrote:

Accompanying new gitversion calculate and gitversion output commands, I support these configuration changes! 👍🏼

Add those commands to the parser in src/, with a usable JSON pipeline. This is a bounded part of #2275; the experimental new-cli/ tree is outside this issue.

Proposed behavior

gitversion calculate --config GitVersion.yml > version.json
gitversion output --input version.json --show-variable FullSemVer
gitversion output --input version.json --output buildserver
gitversion calculate | gitversion output --update-project-files 'src/**/*.csproj'
gitversion calculate | gitversion output --output dotenv

Use the existing POSIX output flags for the first delivery. A wholesale switch to the older proposal's --type/--property vocabulary is outside this scope.

calculate
  • Emit the complete existing variables JSON object and a newline to stdout.
  • Reuse existing repository preparation, version calculation, cache handling and cross-process coordination.
  • Accept the existing repository, configuration, authentication, logging, diagnostic and calculation-control options where applicable.
  • Never emit build-agent commands, update a build number, or modify AssemblyInfo/project/WiX files.
  • Reject output/update flags, variable selection, formatting and configuration-display options, including when placed before the command. Use shell redirection to save calculation JSON.
  • Preserve supported configuration-version selection independently of parser selection.
output
  • Consume a complete variables JSON object from redirected stdin, or --input <file>. Explicit file input takes precedence and does not read stdin; --input - explicitly selects stdin.
  • Fail promptly with usage guidance when invoked interactively without input.
  • Work outside a Git repository without constructing a Git backend, calculating, preparing/fetching/normalizing, accessing the version cache, or acquiring the calculation mutex.
  • Reuse existing JSON/file/buildserver/dotenv output, variable selection, formatting, AssemblyInfo/project/WiX updates, target-directory handling and glob resolution.
  • Preserve GitVersion_ prefixes and existing build-agent selection. Dotenv emits text; it does not change the parent shell's environment.
  • Validate options, the complete input and required configuration before any output side effects. Invalid input must leave files and build-agent outputs untouched.
  • Retain existing incompatible-option checks and JSON/file defaults. Reject calculation/repository/authentication/diagnostic options even when specified before the command.
  • Resolve explicit relative input/config/output paths against the invocation directory; use the selected target directory for update discovery and globbing.
  • Use exit code 0 for success and 1 for errors. Keep diagnostics on stderr and stdout limited to the selected payload or provider protocol.

Configuration-stage contract

Assembly, informational and custom formatting currently happens in VariableProvider before serialization. The incoming JSON should remain an authoritative snapshot: output must not silently recalculate or reinterpret these values.

Proposed first-delivery policy:

  • Keep materialized version fields unchanged during output. Changing their configuration requires rerunning calculate.
  • Resolve update-build-number for build-server output using existing preset → file → runtime-override precedence.
  • Support --config and the relevant runtime override (output.update-build-number for v7, corresponding public key for supported v6 configuration mode). Reject unrelated runtime configuration overrides on output.
  • Discover the four supported configuration filenames in the selected target directory, or use an explicit file. Do not search for a Git root. With no discovered file, use preset defaults; reject an explicitly missing file or ambiguous discovery.
  • Document that other settings in an accepted configuration file do not reformat the snapshot.
  • Avoid configuration loading when the selected output does not need it and no explicit configuration was requested.

Moving all formatting to a separate stage or changing the JSON envelope is a larger follow-up, not a prerequisite for these commands.

Implementation outline

  1. Add explicit combined-root/calculate/output execution intent to argument mapping; retain combined-root behavior as the default.
  2. Register both commands in ArgumentParser, with intentional option scopes and checks for root-supplied options. Keep help and recursive --cli-schema informational.
  3. Separate calculation plus JSON serialization from output side effects, preserving existing mutex/cache behavior.
  4. Dispatch snapshot output through a focused executor before resolving the normal lazy Git executor.
  5. Reuse GitVersionOutputTool, existing serializers and configuration resolution. Add a small testable input seam if needed.
  6. Harden JSON-input validation without breaking existing serializer/file callers or introducing incompatible reflection/AOT behavior.
  7. Update CLI arguments, output, migration and CLI-schema documentation.

Relevant starting points:

  • src/GitVersion.App/ArgumentParser.cs
  • src/GitVersion.App/Arguments.cs
  • src/GitVersion.App/GitVersionApp.cs
  • src/GitVersion.App/GitVersionToolRunner.cs
  • src/GitVersion.Core/Core/GitVersionCalculateTool.cs
  • src/GitVersion.Core/VersionCalculation/VariableProvider.cs
  • src/GitVersion.Output/GitVersionOutputTool.cs
  • src/GitVersion.Output/Serializer/VersionVariableSerializer.cs
  • src/GitVersion.Configuration/ConfigurationProvider.cs

The current serializer assumes constructor keys exist. Validate object shape, required fields, scalar types, duplicate/case-colliding keys and trailing documents before exposing arbitrary stdin. Initially support full JSON from this v7 CLI, including numeric/string/null values and optional provenance fields; do not advertise arbitrary partial or older JSON compatibility without defining it.

Acceptance criteria

  • Both commands are implemented in src/ and compose through a real two-process pipe.
  • calculate produces the same full variables as existing calculation for representative histories/configurations, with no output side effects.
  • output succeeds outside Git; throwing dependency factories prove that Git/calculation services are never constructed.
  • File and stdin input round-trip current JSON, including optional fields. Malformed, partial, duplicate-key, wrong-shape and concatenated input fails before writes.
  • JSON/file/dotenv/buildserver, selection/formatting and file updates retain existing behavior and variable prefixes.
  • Build-number true/false, configuration precedence, directory-only discovery, missing-file/ambiguity errors and snapshot-format preservation are covered.
  • Relative paths, quoted globs, same input/destination file, write failures and interactive missing input are covered.
  • Logs, warnings and errors do not contaminate payload stdout, including under build-agent environments and verbose logging.
  • Before/after-command option placement, rejected options, positional path conflicts and directories named calculate/output have explicit tested behavior.
  • Root combined execution, configuration commands, legacy parser and MSBuild callers retain their behavior. These subcommands are not added to the legacy parser.
  • Help and complete recursive --cli-schema expose the commands and work outside Git without reading stdin or executing operations.
  • Relevant parser, routing, process, output and configuration checks pass; supported Git backends retain calculation parity.
  • Documentation explains the stage boundaries and examples.

Input/configuration errors must cause zero side effects. Multi-target output can retain today's sequential-write behavior: a later I/O failure may leave earlier successful writes completed; cross-file transactions are outside scope.

Related work and boundaries

  • #2275 — broader command-based CLI design; this issue does not close its full scope.
  • #5158 / #5132 — versioned calculation/output configuration.
  • #5160 / #5134 — configuration documentation and the linked review request.

No changes to new-cli/, version-calculation semantics, plugin architecture, normalize, config init/show, parent-environment mutation or wholesale flag naming are proposed. No new dependency is expected.

Implementation has not started. Deliver both working commands together with their pipeline, tests and documentation; parser aliases alone do not satisfy this issue.


Codex responding on behalf of @arturcic.

Ngôn ngữ chính
C#
Star
3.1k
Fork
661
Merge trung bình
7 giờ 4 phút
Pull request đã merge (30 ngày)
77

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của GitTools/GitVersion

Tất cả issue của GitTools/GitVersion

Issue tương tự

Thêm issue về C#

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.