v7.1: remove legacy argument parser and v6 configuration runtime

Đang mở
#5,188 0 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
30/100
Loại issue
Tái cấu trúc
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
csharp, git
Lĩnh vực
cli, documentation, testing

Hướng nghiên cứu

Trước tiên, hãy xác minh điều kiện tiên quyết #5135, sau đó đọc các triển khai selector trong src/GitVersion.App/ArgumentParserVersion.cs, src/GitVersion.Core/Configuration/ConfigurationVersion.cs và các tệp đăng ký được liệt kê trong issue. Chạy các bài kiểm thử feature-selector, thực thi, dòng lệnh và cấu hình đã nêu trước khi thay đổi chúng. Hoàn tất khi các lựa chọn runtime v6 thất bại kèm hướng dẫn di chuyển, v7 vẫn được hỗ trợ, việc di chuyển đầu vào v6 vẫn hoạt động và thông tin chẩn đoán không xuất hiện trong stdout có thể đọc bằng máy.

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

Mô tả

Summary

Split from #5135: remove the legacy argument parser and flat v6 configuration runtime in v7.1, after the v7.0 defaults and temporary fallbacks ship. The completed configuration foundation is #5131 (#5158, #5159, #5160).

Scope

  • Complete prerequisite #5135 (v7.0 selector alignment).
  • Remove LegacyArgumentParser and runtime loading/serialization of flat v6 configuration.
  • Keep gitversion config migrate, including conversion of v6 input, available.
  • Retain GITVERSION_ARGUMENT_PARSER_VERSION and GITVERSION_CONFIGURATION_VERSION during v7.x; reject v6 with actionable removal/migration guidance and accept explicit v7 as a no-op.
  • Preserve consistent selector validation and effective-selection logging without contaminating machine-readable stdout.
  • Remove obsolete runtime tests and update migration/breaking-change documentation; test retired-value diagnostics and retained migration support.

Boundaries and dependencies

#5135 owns v7.0 defaults and temporary fallbacks. #5040 separately removes LibGit2Sharp/native binaries in v7.1. #5136 removes all three selectors in v8 and depends on both v7.1 cleanup issues. Do not remove selectors here.

Cleanup inventory from the v7.0 selector branch

The following inventory comes from arturcic:feature/v7-feature-selectors at 54adbb24e, the implementation of #5135. Implementation PR: #5189, opened from the fork after all four fork workflows passed on that commit. The inventory describes the PR branch; completion of #5135 remains a prerequisite until the PR is merged.

Production code to adapt in v7.1
  • src/GitVersion.App/ArgumentParserVersion.cs: remove the legacy parser implementation path; retain the environment-variable compatibility validator so v6 reports removal guidance and v7 remains accepted. Preserve the actionable diagnostic for the already-retired GITVERSION_USE_V6_ARGUMENT_PARSER boolean.
  • src/GitVersion.Core/Configuration/ConfigurationVersion.cs: retire v6 runtime selection with guidance to gitversion config migrate, while keeping v7 accepted. Remove runtime flat-format loading/serialization without deleting the migration service's ability to read flat v6 input.
  • Adapt src/GitVersion.App/FeatureSelections.cs, CliHost.cs and GitVersionAppModule.cs to register only the v7 parser/configuration. Retain effective-selection snapshots/logging during v7.x and the managed/libgit2 backend boundary owned by #5040.
  • Keep shared normalization/error handling in src/GitVersion.Core/FeatureSelector.cs until all selector removal occurs under #5136. Preserve its source link in new-cli/GitVersion.Common/GitVersion.Common.csproj while the source-linked backend selector still uses it.
  • Preserve Program.cs startup error handling: exit code 1, An error occurred: prefix and actionable stderr text, with no stack trace or machine-readable stdout pollution.
  • Preserve ArgumentParser.MapMigrationValues handling of a root-level --log-file and the stderr routing in ServiceCollectionExtensions.ConfigureLogger. These are retained logging/migration behavior, not disposable v6 scaffolding.
Tests to remove, rewrite or retain
  • src/GitVersion.App.Tests/FeatureSelectorTests.cs: replace v6 success cases in ParserResolvesKnownValues and CompositionRegistersSelectedImplementations with retirement diagnostics; retain normalization/unknown-value tests, RetiredBooleanIsRejectedEvenWithNewSelector and captured-value behavior in SelectionLogUsesCapturedValues using supported selections.
  • src/GitVersion.App.Tests/ExecFeatureSelectorTests.cs: reduce the eight runtime combinations in SelectorCombinationsCalculateAndLogWithoutPollutingOutput to supported implementations; add explicit parser-v6 and configuration-v6 failure cases with migration guidance. Retain JSON, show-variable, show-config and stderr-isolation assertions, including DefaultsSelectV7AndManagedWithConsoleLogsOnStderr and InvalidSelectorsFailBeforeHelpWithActionableStderr.
  • Adapt MigrationRetainsYamlStdoutWithEitherConfigurationAndBackend: v6 input files must still migrate with the supported v7 runtime selection. A removed v6 selector value must not be mistaken for retained flat-file migration support. Coordinate libgit2 cases with #5040.
  • src/GitVersion.App.Tests/ExecCmdLineArgumentTest.cs now selects the fallback through GITVERSION_ARGUMENT_PARSER_VERSION=v6; remove its legacy-parser variants while keeping modern commit-selection and verbosity regressions.
  • Rewrite v6 success cases in src/GitVersion.Core.Tests/Core/ConfigurationVersionSelectorTests.cs and related configuration integration tests as actionable retirement failures. Do not delete normalization, default-selection or migration coverage wholesale.

Update BREAKING_CHANGES.md, docs/input/docs/migration/v6-to-v7.md, docs/input/docs/usage/cli/arguments.md, docs/input/docs/reference/environment-variables.md and docs/design/managed-git-migration.md from temporary-fallback guidance to v7.1 removal guidance. Actual selector-variable removal stays in #5136 for v8.

Output-isolation regression added during #5189 review
  • Preserve the buildServer dimension in ExecFeatureSelectorTests.SelectorCombinationsCalculateAndLogWithoutPollutingOutput: JSON, single-variable and show-config stdout must stay free of diagnostics even when build-server output is also selected. This dimension is independent of the parser/configuration/backend selectors being retired.
  • Retain consistent stderr routing for console logs in ServiceCollectionExtensions.ConfigureLogger. Build-server integration commands keep their existing output channel; diagnostic logs must not move back to stdout during cleanup.
  • Keep CLI help (ArgumentParser and, until legacy removal, legacy_help.md) and the CLI/migration documentation consistent with stderr logging.
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.