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

未关闭
#12 0 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
45/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
停滞
技术栈
powershell
领域
build-system

调研方向

首先定位 MSBuild target 及其当前在项目级别查找 version.txt 的逻辑。添加解决方案级别的查找,并在找不到时回退到项目级别,然后通过测试覆盖这两种配置,并更新项目文档。

由索引模型根据 Issue 内容生成。

描述

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.
主要语言
PowerShell
星标
5
派生
1
PR 合并指标
30 天内没有已合并 PR

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

guibranco/MSBuild.Version.Target 的其他 Issue

查看 guibranco/MSBuild.Version.Target 的全部 Issue

相似的 Issue

更多 Build System Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。