KinsonDigital / BranchValidator

Validates branch names for the organization projects
MIT License
5 stars 1 forks source link

🚀Preview Release #93

Closed CalvinWilkinson closed 1 year ago

CalvinWilkinson commented 1 year ago

Pre-Release ToDo List

Post-Release ToDo List

Additional Information:

Unit Tests

Reasons for local unit test execution:

  • Unit tests might pass locally but not in the CI environment during the status check process or vice-versa.
  • Tests might pass on the developer's machine but not necessarily on the code reviewer's machine.

Version Updating

The version can be updated by setting the values of the <Version/> and <FileVersion/> XML tags in the project file. The <Version/> and <FileVersion/> values can hold production and preview releases. The <AssemblyVersion/> XML tag can only hold production values. Preview values are not allowed.

<!--Preview Release Example-->
<Version>1.2.3-preview.4</Version>
<FileVersion>1.2.3-preview.4</FileVersion>
<AssemblyVersion>1.2.3</AssemblyVersion>


Release Notes

By default, the release notes go into a ReleaseNotes folder inside of the Documentation folder with the Documentation folder at the root of the repository. Preview release notes path: ./Documentation/ReleaseNotes/PreviewReleases.

Release note file names must follow a particular syntax and are in markdown format so they can be added to the release.

Release Notes File Name Syntax:

  • Preview Release Notes:
    • Syntax: Release-Notes-v#.#.#-preview.#.md
    • Example: Release-Notes-v1.2.3-preview.4.md

Changes such as release notes and version updates should be committed to the destination branch (preview/v#.#.#-preview.#) in the pull request attached to this issue.


Code of Conduct