-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #65 from KinsonDigital/preview/v1.0.0-preview.2
Release To Preview - v1.0.0-preview.2
- Loading branch information
Showing
51 changed files
with
1,857 additions
and
556 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| github: KinsonDigital | ||
| ko_fi: kinsondigital |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| blank_issues_enabled: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| name: ✨ Feature Request | ||
| description: Add a new feature. | ||
| title: "✨" | ||
| labels: [✨new feature] | ||
| body: | ||
| - type: checkboxes | ||
| attributes: | ||
| label: Complete The Items Below | ||
| options: | ||
| - label: I have updated the title without removing the ✨ emoji. | ||
| required: true | ||
| - label: I searched whether or not a feature request already exists. | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: Feature Request Purpose | ||
| description: A clear and concise description of the problem that your feature request solves (i.e. I'm frustrated when [...] or I would like to improve [...]). | ||
| validations: | ||
| required: false | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: Solution | ||
| description: A clear and concise description of your proposed solution. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: Anything Else | ||
| description: | | ||
| Links? References? Please provide anything that will give us more context about the feature request. | ||
| placeholder: "Tip: You can drag and drop files here." | ||
| validations: | ||
| required: false | ||
|
|
||
| - type: checkboxes | ||
| id: terms | ||
| attributes: | ||
| label: Code of Conduct | ||
| description: By submitting this issue, you agree to follow our [Code of Conduct](../../code_of_conduct.md) | ||
| options: | ||
| - label: I agree to follow this project's Code of Conduct | ||
| required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| name: 🚧 Project Item | ||
| description: Create an issue for a project (Project maintainers only). | ||
| title: "🚧" | ||
| body: | ||
| - type: checkboxes | ||
| attributes: | ||
| label: Complete The Item Below | ||
| options: | ||
| - label: I have updated the title without removing the 🚧 emoji. | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: Description | ||
| description: A description of the feature and/or change. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: Acceptance Criteria | ||
| placeholder: | | ||
| Example: | ||
| - [ ] Item 1 complete | ||
| - [ ] Item 2 complete | ||
| description: The items to complete in order to satisfy the Definition of Done. | ||
| validations: | ||
| required: true | ||
| render: markdown | ||
|
|
||
| - type: checkboxes | ||
| attributes: | ||
| label: ToDo Items | ||
| description: Complete the following items before requesting a PR review. | ||
| options: | ||
| - label: Change type labels added to this issue. Refer to the _**Change Type Labels**_ section below. | ||
| - label: Priority label added to this issue. Refer to the _**Priority Type Labels**_ section below. | ||
| - label: Issue linked to the correct project _(if required)_. | ||
| - label: Issue linked to the correct milestone _(if required)_. | ||
| - label: Draft pull request created and linked to this issue _(only required with code changes)_. | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: Issue Dependencies | ||
| placeholder: | | ||
| Example: | ||
| - #10 | ||
| - #20 | ||
| description: | | ||
| A list of issues that are dependencies of this issue and need to be completed first. | ||
| validations: | ||
| required: false | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: Related Work | ||
| placeholder: | | ||
| Example: | ||
| - #10 | ||
| - #20 | ||
| description: | | ||
| A list of issues related to this issue but are not a dependency. | ||
| validations: | ||
| required: false | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: "Additional Information:" | ||
| description: DO NOT CHANGE ANYTHING BELOW!! | ||
| value: | | ||
| **_<details closed><summary>Change Type Labels</summary>_** | ||
| | Change Type | Label | | ||
| |---------------------|--------------------------------------------------------------------------------------| | ||
| | Bug Fixes | https://github.com/KinsonDigital/VersionMiner/labels/%F0%9F%90%9Bbug | | ||
| | Breaking Changes | https://github.com/KinsonDigital/VersionMiner/labels/%F0%9F%A7%A8breaking%20changes | | ||
| | New Feature | https://github.com/KinsonDigital/VersionMiner/labels/%E2%9C%A8new%20feature | | ||
| | Workflow Changes | https://github.com/KinsonDigital/VersionMiner/labels/workflow | | ||
| | Code Doc Changes | https://github.com/KinsonDigital/VersionMiner/labels/%F0%9F%93%91documentation%2Fcode | | ||
| | Product Doc Changes | https://github.com/KinsonDigital/VersionMiner/labels/%F0%9F%93%9Ddocumentation%2Fproduct | | ||
| </details> | ||
| **_<details closed><summary>Priority Type Labels</summary>_** | ||
| | Priority Type | Label | | ||
| |---------------------|--------------------------------------------------------------------| | ||
| | Low Priority | https://github.com/KinsonDigital/VersionMiner/labels/low%20priority | | ||
| | Medium Priority | https://github.com/KinsonDigital/VersionMiner/labels/medium%20priority | | ||
| | High Priority | https://github.com/KinsonDigital/VersionMiner/labels/high%20priority | | ||
| </details> | ||
| - type: checkboxes | ||
| id: terms | ||
| attributes: | ||
| label: Code of Conduct | ||
| description: By submitting this issue, you agree to follow our [Code of Conduct](../../code_of_conduct.md). | ||
| options: | ||
| - label: I agree to follow this project's Code of Conduct. | ||
| required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| name: 🚀 Release To Do List | ||
| description: Used to perform a release (Project maintainers only). | ||
| title: "🚀Release To <TODO: release type here> - <TODO: release version number here>" | ||
| body: | ||
| - type: textarea | ||
| attributes: | ||
| label: Issues Released | ||
| placeholder: | | ||
| Create a list of all the items being released. | ||
| Example: | ||
| - #10 | ||
| - #20 | ||
| description: The list of issues that will be released. | ||
| validations: | ||
| required: true | ||
| render: markdown | ||
|
|
||
|
|
||
| - type: checkboxes | ||
| attributes: | ||
| label: Perform Release ToDo List | ||
| description: Complete the following items to perform a release. | ||
| options: | ||
| - label: "Title updated by replacing the '**_<TODO: release type here>_**' section with the type of release." | ||
| - label: "Title updated by replacing the '**_<TODO: release version number here>_**' section with the version number." | ||
| - label: Appropriate release label added to this issue. Refer to the _**Release Labels**_ section below. | ||
| - label: Release PR linked to this issue. | ||
| - label: Manual QA Testing completed. | ||
| - label: All issues listed in the **_Issues Released_** section above. | ||
| - label: All issues in the _**Issues Released**_ section are closed and all issue tasks are complete. | ||
| - label: All unit tests have been executed locally and have passed. (Check out the appropriate release branch before running tests). | ||
| - label: Version in project file updated (All changes made directly on the release branch). | ||
| - label: Release notes created and added (All changes made directly on the release branch). | ||
| - label: Release to **_preview_** or **_production_** complete. Refer to the release execution section below. | ||
|
|
||
|
|
||
| # POST-RELEASE TODO LIST | ||
| - type: checkboxes | ||
| attributes: | ||
| label: Post-Release ToDo List | ||
| description: Verify that release went smoothly. | ||
| options: | ||
| - label: The release displayed in [GitHub Releases](https://github.com/KinsonDigital/VersionMiner/releases) is correct. | ||
| - label: The [nuget package](https://www.nuget.org/packages/KinsonDigital.VersionMiner/) has been successfully deployed to the public repository. | ||
| - label: Announcement of release on [Twitter](https://twitter.com/KDCoder) verified. (Announcement should be performed automatically with the release) | ||
| - label: Announcement has been pushed to [Ko-Fi](https://ko-fi.com/kinsondigital). | ||
| - label: Announcement has been pushed to the correct [GitHub Release Discussion Board](https://github.com/KinsonDigital/VersionMiner/discussions/categories/releases). | ||
| - label: Announcement has been pushed to the Discord channel. | ||
|
|
||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: "Additional Information:" | ||
| description: DO NOT CHANGE ANYTHING BELOW!! | ||
| value: | | ||
| **_<details closed><summary>Release Labels</summary>_** | ||
| | 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 | | ||
| </details> | ||
| --- | ||
| **_<details closed><summary>Unit Tests</summary>_** | ||
| 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. | ||
| </details> | ||
| --- | ||
| **_<details closed><summary>Version Updating</summary>_** | ||
| The version can be updated by setting the values of the `<Version/>` and `<FileVersion/>` XML tags in the project file. | ||
| ``` xml | ||
| <!--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> | ||
| ``` | ||
| </details> | ||
| --- | ||
| **_<details closed><summary>Release Notes</summary>_** | ||
| 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. | ||
| </details> | ||
| --- | ||
| **_<details closed><summary>Release Execution</summary>_** | ||
| The release is performed by running one of the release workflows below: | ||
| - [Preview Release](https://github.com/KinsonDigital/VersionMiner/actions/workflows/preview-release.yml) | ||
| - [Production Release](https://github.com/KinsonDigital/VersionMiner/actions/workflows/qa-prod-releases.yml) | ||
| </details> | ||
| validations: | ||
| required: true | ||
| render: markdown | ||
|
|
||
|
|
||
| # CODE OF CONDUCT | ||
| - type: checkboxes | ||
| id: terms | ||
| attributes: | ||
| label: Code of Conduct | ||
| description: By submitting this issue, you agree to follow our [Code of Conduct](../../code_of_conduct.md) | ||
| options: | ||
| - label: I agree to follow this project's Code of Conduct | ||
| required: true |
Oops, something went wrong.