Auto generate the change log and releases in CI

.github/workflows/release-notes.yml

@@ -0,0 +1,76 @@
+name: Release Notes
+
+on:
+  push:
+    branches:
+      - 'main'
+      - 'release/**'
+  pull_request:
+    branches:
+      - 'main'
+      - 'release/**'
+
+jobs:
+  release_notes:
+    runs-on: ubuntu-20.04
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0 # Required for GitVersion
+
+      # Require .NET 5 for GitVersion and .NET 3 for GitRelesaseManager
+      - name: Setup .NET Core 5 (GitVersion)
+        uses: actions/setup-dotnet@v1
+        with:
+          dotnet-version: 5.0.x
+
+      - name: Setup .NET Core 3 (GitReleaseManager)
+        uses: actions/setup-dotnet@v1
+        with:
+          dotnet-version: 3.0.x
+
+      - name: Install GitVersion
+        uses: gittools/actions/gitversion/[email protected]
+        with:
+          versionSpec: '5.6.6'
+
+      - name: Show GitVersion Config
+        uses: gittools/actions/gitversion/[email protected]
+        with:
+          useConfigFile: true
+          additionalArguments: '/showConfig'
+
+      - name: Determine Version
+        uses: gittools/actions/gitversion/[email protected]
+        id: gitversion
+        with:
+          useConfigFile: true
+
+      - uses: gittools/actions/gitreleasemanager/[email protected]
+        name: Install GitReleaseManager
+        with:
+          versionSpec: '0.11.0'
+
+      - uses: gittools/actions/gitreleasemanager/[email protected]
+        name: Create/Update GitHub Release ${{ steps.gitversion.outputs.majorMinorPatch }}
+        continue-on-error: true
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          owner: 'corgibytes'
+          repository: 'freshli'
+          milestone: 'v${{ steps.gitversion.outputs.majorMinorPatch }}' 
+
+      # This will generate the change log for all the GitHub Releases, feature
+      # is not included in the GitReleaseManager action yet.
+      - name: Generate Change Log
+        run: |
+          dotnet-gitreleasemanager export --token ${{ secrets.GITHUB_TOKEN }} -o 'corgibytes' -r 'freshli' -f 'CHANGELOG.md'
+          cat CHANGELOG.md
+
+      - uses: stefanzweifel/git-auto-commit-action@v4
+        name: Commit Change Log and if it Changed
+        with:
+          commit_message: Committing auto generated change log.
+          file_pattern: CHANGELOG.md

CHANGELOG.md

@@ -0,0 +1,20 @@
+## v0.3.0
+
+
+As part of this release we had [4 issues](https://github.com/corgibytes/freshli/milestone/4?closed=1) closed.
+
+Goals for this milestone:
+
+- Alpha NuGet package published to GitHub Packages
+- Automate calculation of version number and change log
+- Clean-up of the ReadMe.
+- Basic support for Ruby, .NET, Python, Perl, and PHP.
+
+__Enhancements__
+
+- [__#239__](https://github.com/corgibytes/freshli/pull/239) Deploys Alpha Packages to Github Packages
+- [__#238__](https://github.com/corgibytes/freshli/pull/238) Sets VSCode container development
+- [__#228__](https://github.com/corgibytes/freshli/issues/228) Auto-magically calculate version number
+- [__#4__](https://github.com/corgibytes/freshli/issues/4) Add support for NuGet (specific to using Freshli.Core)
+
+

README.md

@@ -247,8 +247,10 @@ with the [act](https://github.com/nektos/act) tool.
 act -s secret_key=secret_value
 ```
 
-## Branching and Versioning
+## Branching, Versioning, and Change Log
 
 This project uses cactus branching which means development is done in feature branches merged to the `main` branch and releases are done in `release-X.Y` branches off of main.  Any fixes found testing a release are merged back to the release branch and then merged back to main.  Another name for this branching strategy is Trunk Based [Development](https://trunkbaseddevelopment.com/).
 
 The next version is automatically calculated using [GitVersion](https://github.com/GitTools/GitVersion).  Commits to the main branch have the alpha suffix in their version number (e.g. v1.0.0-alpha0001).  All commits to the release branches have the rc suffix (e.g. v1.0.0-beta).  When a production release is done a tag without any suffix is used (e.g. v1.0.0).  This tag is then used by GitVersion to calculate future versions.  The configuration for GitVersion can be found [GitVersion.yml].
+
+The [CHANGELOG.md] and the GitHub [Releases](https://github.com/corgibytes/freshli/releases) are generated by [GitReleaseManager](https://github.com/GitTools/GitReleaseManager) as part our continous integeragion (CI) process.  This requires that a milestone be created that follows semantic versionion (e.g. v1.0.0) and that issues are assigned to the milestone.  During CI the [CHANGELOG.md] and any draft GitHub  will and the current draft GitHub Release will be updated with any issues that have been closed.