#8 Added changelog manager

.github/workflows/CI.yml

@@ -9,6 +9,7 @@ on:
  push:
  branches:
  - main
+ - stage
 
 jobs:
  test-starter:

.github/workflows/codeql-anaysis.yml

@@ -8,6 +8,7 @@ on:
  push:
  branches:
  - main
+ - stage
  schedule:
  - cron: '00 0 * * 1'
 

.github/workflows/release.yml

@@ -0,0 +1,50 @@
+name: Release
+
+# Triggering the workflow on pushes to main
+on:
+ push:
+ branches:
+ - main
+
+jobs:
+ # Release job
+ release:
+ name: Release
+ runs-on: ubuntu-latest
+
+ steps:
+ # Checkout
+ - name: Checkout
+ uses: actions/checkout@v3
+
+ # Bump version and update changelog
+ - name: Bump version and update changelog
+ id: version-bump
+ uses: Enterwell/ChangelogManager-GitHub-Action@v3
+ with:
+ should-bump-version: true
+ path-to-project-file: ./Acme.Interface.WebAPI/Acme.Interface.WebAPI.csproj
+
+ # Committing new changes
+ - name: Commit changes
+ uses: EndBug/[email protected]
+ with:
+ message: "[skip ci] [version-bump] Automated commit for version ${{ steps.version-bump.outputs.bumped-semantic-version }}"
+
+ # # Update Git tags - uncomment once you add your secrets and configs
+ # - name: Git tags update
+ # run: |
+ # git config user.name github-actions
+ # git config user.email [email protected]
+
+ # git tag "v${{ steps.version-bump.outputs.bumped-semantic-version }}"
+ # git tag -f "v${{ steps.version-bump.outputs.bumped-major-part }}" "v${{ steps.version-bump.outputs.bumped-semantic-version }}"
+ # git tag -f "v${{ steps.version-bump.outputs.bumped-major-part }}.${{ steps.version-bump.outputs.bumped-minor-part }}" "v${{ steps.version-bump.outputs.bumped-semantic-version }}"
+
+ # git push -f --tags
+
+ # # Creating latest release
+ # - name: Create GitHub release
+ # run: gh release create "v${{ steps.version-bump.outputs.bumped-semantic-version }}" -n "${{ steps.version-bump.outputs.new-changes }}"
+ # env:
+ # GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Acme.Interface.WebAPI/Acme.Interface.WebAPI.csproj

@@ -7,6 +7,7 @@
  <UserSecretsId>680006c1-a722-4bf8-8116-b8c2fba51400</UserSecretsId>
  <DockerDefaultTargetOS>Linux</DockerDefaultTargetOS>
  <DockerComposeProjectPath>..\docker-compose.dcproj</DockerComposeProjectPath>
+ <Version>1.0</Version>
  </PropertyGroup>
 
  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">

CHANGELOG.md

@@ -0,0 +1,3 @@
+_NOTE: This is an automatically generated file. Do not modify contents of this file manually._
+
+## [Unreleased]

README.md

@@ -46,6 +46,8 @@
 + 🛠️ [Prerequisites](#-prerequisites)
 + 🔰 [Getting started](#-getting-started)
 + 🏛️ [Project structure](#-project-structure)
++ 🔄 [Continous integration](#-continous-integration)
++ 📄 [Changelog manager](#-changelog-manager)
 + ☎️ [Support](#-support)
 + 🪪 [License](#-license)
 
@@ -146,6 +148,25 @@ Layer that acts as a set of adapters that convert data from the format most conv
 
 So, to be frank, only *Program.cs* is referencing Infrastructure and for that reason, we previously had a separate layer called `Interface.WebAPI.Starter` that would be bootstrapping the application and its' DI container. But, to reduce the number of layers, we stopped with that practice.
 
+### 🔄 Continous integration
+
+We've set up a couple of basic CI pipelines for GitHub Actions. You should review them and correct your branch names, if needed.
+
+There are actions for:
+
++ Continous integration (CI) - checkouts, restores packages, builds, runs unit tests and adds code coverage
++ Code quality analysis - runs code quality analysis using CodeQL
++ Release - bumps the release version and merges _changelog entries_ into `CHANGELOG.MD` and optionally adds the git tag (if configured)
+
+## 📄 Changelog manager
+
+We like to see a nice and up-to-date changelog between releases, but sometimes that's just too much work. To simplify this process, we've developed our own [Changelog Manager](https://github.com/Enterwell/ChangelogManager) which adheres to the [Keep a changelog](https://keepachangelog.com/en/1.0.0/#how) principles, along with a couple of integrations to help you create _changelog entries_:
+
++ [Visual Studio extension](https://marketplace.visualstudio.com/items?itemName=Enterwell.EnterwellChangelogVsix)
++ [CLI tool](https://github.com/Enterwell/ChangelogManager/blob/main/Enterwell.CI.Changelog.CLI/README.md#changelog-create-cli-tool)
+
+In short, you create _changelog entries_ either by manually adding entries (files) into the `./changes` folder (if you _really_ want to do it that way...) or by using one of the above mentioned tools. As your PR's are merged into the `stage` branch (or your equivalent development branch) this folder will accumulate entries which will be bundled up into your `CHANGELOG.MD` when you create a release (ie. when you merge `stage` into `main`), and the folder will be purged. Rinse and repeat for your next release!
+
 ## ☎ Support
 If you are having problems, please let us know by [raising a new issue](https://github.com/Enterwell/dotnet-starter/issues/new).