🚀Production Release - v1.0.0

Version Miner Production Release Notes - v1.0.0

This is the first release to production!! This contains the same binary as v1.0.0-preview.5

🚀Preview Release - v1.0.0-preview.5

Version Miner Preview Release Notes - v1.0.0-preview.5

Quick Reminder

As with all software, there is always a chance for issues and bugs, especially for preview releases, which is why your input is greatly appreciated. 🙏🏼

---

Bug Fixes 🐛

1. #143 - Fixed a bug where authorization/permission issues were not being captured correctly and displaying misleading errors and problems in the logs.

---

Other 🪧

(Includes anything that does not fit into the categories above)

1. #141 - Created release workflow to make releases easier and more robust.
2. #136 - Updated the contributor covenant badge.
3. #135 - Changed project branching model and adjusted CICD workflows accordingly.

🚀Preview Release - 1.0.0-preview.4

VersionMiner Preview Release Notes - v1.0.0-preview.4

Quick Reminder

As with all software, there is always a chance for issues and bugs, especially for preview releases, which is why your input is greatly appreciated. 🙏🏼

---

Nuget/Library Updates 📦

1. #81, #107 - Updated package Octokit version v2.0.1 to v5.0.2
2. #122 - Updated package System.IO.Abstractions from version v19.1.14 to v19.2.4
3. #119 - Updated Moq from v4.18.1 to v4.18.4
4. #118 - Updated Microsoft.CodeAnalysis.NetAnalyzers from v7.0.0 to v7.0.1
5. #116 - Updated coverlet.collector from v3.1.2 to v3.2.0
6. #115 - Updated Microsoft.Extensions.DependencyInjection.Abstractions from v6.0.0 to v7.0.0
7. #109 - Updated Microsoft.NET.Test.Sdk from v17.2.0 to v17.5.0
8. #106 - Updated xunit from v2.4.1 to v2.4.2.
9. #104 - Updated RestSharp from v108.0.1 to v108.0.3
10. #103 - Updated coverlet.collector from v3.1.2 to v3.2.0

---

Other 🪧

(Includes anything that does not fit into the categories above)

1. #131, #113 - Project README greatly improved.
2. #123 - Updated code coverage configuration to ensure a minimum of 85% coverage.
3. #121 - Changed the name of a step in a workflow.
4. #111 - Added the .md extension to the project's license file.
5. #108 - Removed unused project files and documents.

🚀Preview Release - 1.0.0-preview.3

VersionMiner Preview Release Notes - v1.0.0-preview.3

Quick Reminder

As with all software, there is always a chance for issues and bugs, especially for preview releases, which is why your input is greatly appreciated. 🙏🏼

---

Bug Fixes 🐛

1. #83 - Fix a bug where the GitHub console output was incorrect when an invalid branch was detected.

---

Other 🪧

(Includes anything that does not fit into the categories above)

1. #94 - Improved and updated how repository data is pulled.

   💡This data pulled is the file where the versions are contained.

2. #93 - Changed how workflow step outputs are dealt with.

   💡This is a required change related to workflow changes that GitHub is enforcing. Want more info? Go here.

3. #89 - Set up a dependabot for managing dependencies.
4. #88 - Updated the workflows for new workflow job step outputs.

   💡This is a required change related to workflow changes that GitHub is enforcing.

5. #86 - Updated dotnet from version v6.0 to v7.0
6. #82 - Changed how internal visibility is exposed to the unit test project.
7. #75 - Replaced a custom-written library used to get GitHub data with Octokit.
8. #73 - Removed PR and issue templates.

   💡This enables the project to use the templates from the entire organization.

9. #44 - Added automated code coverage to the CI/CD process by using codecov.
10. #9 - Greatly improved the CI/CD release pipeline.

🚀Preview Release - v1.0.0-preview.2

VersionMiner Preview Release Notes - v1.0.0-preview.2

Quick Reminder

As with all software, there is always a chance for issues and bugs, especially for preview releases, which is why your input is greatly appreciated. 🙏🏼

---

New Features ✨

1. #17 - Added create issue link to action console output.
   • Clicking this link will take you directly to the create issue page for the project.
2. #45 - Added a new input named trim-start-from-branch.
   • This new feature will trim the value of the trim-start-from-branch input from the name of the branch-name input value. This is useful to trim extra textual artifacts from the branch added by using GitHub default environment variables.
3. #45 - Changed the file-format input to not use case sensitive values.
   • This means the value xml and XML are the same. Previously it was case sensitive and a value like XML would of failed the workflow.
4. #49 - Replace built in GitHubDataService related code with the new library GitHubData.
5. #48 - Added new action input named repo-token.
   • This adds the ability for VersionMiner to be able to make authenticated requests so the request rate limits are not reached when the action is executed. Refer to the GitHub API Authentication documentation for more information on request rate limits.

---

Breaking Changes 🧨

1. #45 - Refactored the name of the InvalidFileTypeException exception to InvalidFileFormatException.

---

Nuget/Library Updates 📦

1. #45 - Update nuget package xunit.runner.visualstudio from v2.4.3 to v2.4.5 in the unit testing project.
2. #45 - Update nuget package Microsoft.NET.Test.Sdk from v17.1.0 to v17.2.0 in the unit testing project.
3. #45 - Update nuget package CommandLineParser from v2.8.0 to v2.9.1 in the main project.
4. #48 - Update nuget package KinsonDigital.GitHubData from v1.0.0-preview.4 to v1.0.0-preview.5.

---

Other 🪧

(Includes anything that does not fit into the categories above)

1. #23 - Refactored the word "ubuntu" to the value of "Ubuntu".
   • This was just a simple documentation improvement.
2. #25 - Added badges to the project's README file.
   • Added a latest releases badge.
   • Added a unit test status badge.
   • Added a discord server badge.
   • Added a twitter badge.
3. #26 - Created a project item issue template for creating project items for project maintainers.
4. #27 - Created a build and unit testing status check workflows to be executed for pull requests.
5. #28 - Changed the GitHub action marketplace icon from a settings icon to a search icon.
6. #29 - Setup the solution to hold release notes.
   • This will help keep a history of the release notes as well as help publish release notes with the releases.
7. #31 - Setup project to display the KinsonDigital contributions button.
8. #32 - Fixed a documentation issue in the project README file where the YAML examples were using the incorrect inputs.
9. #45 - Improved README file in various areas.
10. #45 - Added documentation for the new trim-start-from-branch input in the README file with an example.
11. #45 - Refactor exception messages to show the input names that are in seen in the workflow when being used.
12. #45 - Added 3 live templates for JetBrains Rider users to easily create unit test methods. Live template names below:
    • xu-null-ctor-param
    • xu-create-test-obj-method
    • xu-test-method
13. #45 - Added an integration tests project to the solution named VersionMinerIntegrationTests.
    • ⚠️Currently this test project make HTTP requests to a test repository that lives in the KinsonDigital organization named ActionTestRepo. This repository is for the sole purpose of testing out various organizational GitHub actions. These integration tests do not authenticate with login credentials or a PAT, which results in a request/hour limit of 60. This is currently being worked on and will be available on a future preview release. Refer to Issue #47 for more info.
14. #55 - Updated and added issue and PR templates to project.
15. #53 - Added code of conduct to project.
16. #58 - Added branching documentation to the project.
17. #61 - Fix issue with release todo issue template.
    • This involved removing illegal characters from the template that was causing it to not function properly when create a new GitHub issue.

🚀Preview Release v1.0.0-preview.1

VersionMiner Preview Release Notes - v1.0.0-preview.1

Quick Reminder

As with all software, there is always a chance for issues and bugs, especially for preview releases, which is why your input is greatly appreciated. 🙏🏼

---

New Features ✨

1. #14 - Initial creation of GitHub action