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

オープン
#12 コメント 0 件 リアクション 1 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
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 はありません

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

guibranco/MSBuild.Version.Target のほかの issue

guibranco/MSBuild.Version.Target の issue をすべて見る

似ている issue

Build System の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。