Support automated release notes

.devcontainer/devcontainer.json

@@ -15,6 +15,8 @@
         "cake-build.cake-vscode",
         "streetsidesoftware.code-spell-checker",
         "hediet.vscode-drawio",
+        "yzhang.markdown-all-in-one",
+        "davidanson.vscode-markdownlint"
     ],
 
     "remoteUser": "vscode",

.github/workflows/build-and-release.yml

@@ -80,6 +80,8 @@ jobs:
       # No need to stage as one job can create the binaries for all platforms
       - name: "Build and test"
         run: dotnet cake --target=BuildTest --configuration=${{ env.BUILD_CONFIG }} --verbosity=diagnostic
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
   # Preview release on push to develop only
   preview:
@@ -101,7 +103,6 @@ jobs:
         with:
           dotnet-version: ${{ env.NET_SDK }}
 
-      # TODO: #5 Generate release notes and update draft release
       # TODO: #14 Generate preview doc and publish to branch
 
       - name: "Install Azure Artifacts Credential Provider"

GitReleaseManager.yaml

@@ -0,0 +1,44 @@
+# Configuration values used when creating new releases
+create:
+ include-footer: false
+ include-sha-section: false
+ allow-update-to-published: false
+
+# Configuration values used when exporting release notes
+export:
+ include-created-date-in-title: true
+ created-date-string-format: MMMM dd, yyyy
+ perform-regex-removal: false
+
+# Configuration values used when closing a milestone
+close:
+ use-issue-comments: false
+#  issue-comment: |-
+#    :tada: This issue has been resolved in version {milestone} :tada:
+#
+#    The release is available on:
+#
+#    - [GitHub release](https://github.com/{owner}/{repository}/releases/tag/{milestone})
+#
+#    Your **[GitReleaseManager](https://github.com/GitTools/GitReleaseManager)** bot :package::rocket:
+
+# The labels that will be used to include issues in release notes.
+issue-labels-include:
+  - Breaking
+  - Bug
+  - Documentation
+  - Duplicate
+  - Enhancement
+  - Feature
+  - Improvement
+  - Question
+
+# The labels that will NOT be used when including issues in release notes.
+issue-labels-exclude:
+  - Internal Refactoring
+
+# Overrides default pluralization and header names for specific labels.
+issue-labels-alias:
+  - name: Documentation
+    header: Documentation
+    plural: Documentation

README.md

@@ -7,14 +7,13 @@ project.
 
 Requirements:
 
-- .NET Core 3.1 SDK
+- .NET Core 5.0 SDK
 
 Steps:
 
 ```sh
 # Run these command only the first time to get the build tools
 dotnet tool restore
-dotnet cake --bootstrap
 
 # Build, test and stage artifacts
 dotnet cake

docs/dev/Changelog.md

@@ -0,0 +1,3 @@
+# Changelog
+
+To be filled on preview builds.

docs/dev/toc.yml

@@ -0,0 +1,4 @@
+- name: Changelog
+  href: Changelog.md
+- name: API
+  href: ../api/toc.yml

docs/docfx.json

@@ -18,7 +18,7 @@
     "build": {
       "content": [
         {
-          "files": [ "api/**.yml" ]
+          "files": [ "api/**.yml", "dev/**" ]
         },
         {
           "files": [ "toc.yml", "index.md" ]
@@ -40,7 +40,9 @@
       "globalMetadataFiles": ["global_metadata.json"],
       "fileMetadataFiles": [],
       "template": [
-        "default"
+        "default",
+        "statictoc",
+        "default-widescreen"
       ],
       "postProcessors": [],
       "markdownEngineName": "markdig",

docs/global_metadata.json

@@ -1,13 +1,13 @@
 {
-    "_appTitle": ".NET DevOps Pipeline",
+    "_appTitle": "PleOps.Cake project template",
     "_appFooter": "Copyright (c) 2019 Benito Palacios Sánchez",
     "_appLogoPath": "images/logo_48.png",
     "_appFaviconPath": "images/favicon.png",
     "_enableSearch": true,
     "_enableNewTab": true,
     "_gitContribute": {
         "apiSpecFolder": "docs/apidoc",
-        "repo": "https://dev.azure.com/benito356/_git/NetDevOpsTest",
+        "repo": "https://github.com/pleonex/template-csharp",
         "branch": "develop"
     }
 }

docs/toc.yml

@@ -5,7 +5,7 @@
   href: guides/
 
 - name: API
-  href: api/
+  href: dev/
 
-- name: Project
-  href: https://dev.azure.com/benito356/NetDevOpsTest
+- name: GitHub
+  href: https://github.com/pleonex/csharp-template