KinsonDigital/VersionMiner

🚀Release To Preview - v1.0.0-preview.2

Closed this issue · 1 comments

CalvinWilkinson commented

Issues Released

Perform Release ToDo List

  • Title updated by replacing the '<TODO: release type here>' section with the type of release.
  • Title updated by replacing the '<TODO: release version number here>' section with the version number.
  • Appropriate release label added to this issue. Refer to the Release Labels section below.
  • Release PR linked to this issue.
  • Manual QA Testing completed.
  • All issues listed in the Issues Released section above.
  • All issues in the Issues Released section are closed and all issue tasks are complete.
  • All unit tests have been executed locally and have passed. (Check out the appropriate release branch before running tests).
  • Version in project file updated (All changes made directly on the release branch).
  • Release notes created and added (All changes made directly on the release branch).
  • Release to preview or production complete. Refer to the release execution section below.

Post-Release ToDo List

  • The release displayed in GitHub Releases is correct.
  • The nuget package has been successfully deployed to the public repository.
  • Announcement of release on Twitter verified. (Announcement should be performed automatically with the release)
  • Announcement has been pushed to Ko-Fi.
  • Announcement has been pushed to the correct GitHub Release Discussion Board.
  • Announcement has been pushed to the Discord channel.

Additional Information:

Release Labels

Release Types Label Used
Preview Release https://github.com/KinsonDigital/VersionMiner/labels/%F0%9F%9A%80Preview%20Release
Production Release https://github.com/KinsonDigital/VersionMiner/labels/%F0%9F%9A%80Production%20Release
Hot Fix Release https://github.com/KinsonDigital/VersionMiner/labels/%F0%9F%9A%80Hot%20Fix%20Release

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.

<!--Syntax for preview releases-->
<Version>1.2.3-preview.4</Version>
<FileVersion>1.2.3-preview.4</FileVersion>

<!--Syntax for production releases-->
<Version>1.2.3</Version>
<FileVersion>1.2.3</FileVersion>

Release Notes

The release notes go into the appropriate folder:

  • Preview Release Notes go into the ~/Documentation/ReleaseNotes/PreviewReleases folder.
  • Production Release Notes go into the ~/Documentation/ReleaseNotes/ProductionReleases folder.

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<major>.<minor>.<patch>-preview.<prev-num>.md
    • Example: Release-Notes-v1.0.0-preview.4.md
  • Production Release Notes:
    • Syntax: Release-Notes-v<major>.<minor>.<patch>.md
    • Example: Release-Notes-v1.0.0.md

Changes such as release notes and version updates should be committed to the same source branch in the pull request attached to this issue.

Release Execution

The release is performed by running one of the release workflows below:

Code of Conduct

  • I agree to follow this project's Code of Conduct
CalvinWilkinson commented

QA testing not performed due to it not being setup.