[FEATURE] Support Single Version.txt File for Entire Solution

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

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

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
45/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
powershell
Lĩnh vực
build-system

Hướng nghiên cứu

Bắt đầu bằng việc xác định MSBuild target và cách tra cứu version.txt hiện tại ở cấp dự án. Thêm tra cứu ở cấp solution với fallback về cấp dự án, sau đó viết test cho cả hai cấu hình và cập nhật tài liệu của dự án.

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

Mô tả

enhancement gitauto good first issue help wanted
Description

Currently, our MSBuild target generates a Semantic Version (SemVer) for each project in the solution based on individual version.txt files. This approach can lead to redundancy and inconsistencies when managing versioning across multiple projects.

To simplify version management, we propose allowing a single version.txt file to be used for the entire solution instead of requiring separate files for each project.

Proposed Changes
  1. Single Version File:

    • Introduce support for a centralized version.txt file located at the solution level, which all projects can reference for versioning.
    • Ensure that the MSBuild target reads from this single file and generates the same SemVer for all projects in the solution.
  2. Backwards Compatibility:

    • Maintain support for existing projects that still use individual version.txt files.
    • Implement logic to check for the presence of a solution-level version.txt and prioritize it over project-level files if both exist.
  3. Documentation Update:

    • Update the project documentation to reflect this new feature, including setup instructions for using the centralized versioning approach.
  4. Testing:

    • Create test cases to ensure that the versioning behaves as expected when using both the centralized and individual version.txt setups.
Benefits
  • Simplified Version Management: Having a single version file reduces redundancy and makes it easier to manage versioning across multiple projects.
  • Consistency: Ensures that all projects in the solution are using the same version number, preventing discrepancies and confusion.
  • Ease of Use: Simplifies the process for developers, who will no longer need to update multiple version files for each release.
Ngôn ngữ chính
PowerShell
Star
5
Fork
1
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

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

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 guibranco/MSBuild.Version.Target

Tất cả issue của guibranco/MSBuild.Version.Target

Issue tương tự

Thêm issue về Build System

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.