readme updates and add assembly info about the date

Author: baronfel

CHANGELOG.md

@@ -1,6 +1,13 @@
 # Changelog
 
-## [Unreleased]
+## [0.1.1] - 2022.01.14
+
+### Added
+
+- Now writes an assembly-level AssemblyMetadataAttribute with the key "BuildDate" whose
+value is the `YYYY-mm-dd`-formatted date in the release changelog
+
+## [0.1.0] - 2022.01.13
 
 ### Added
 

README.md

@@ -1,15 +1,71 @@
 # Ionide.KeepAChangelog
 
-This project implements a Changelog parser according to the spec at KeepAChangelog. It also provides MSBuild tasks and targets to automate the setting of Versions and Package Release Notes for your NuGet packages, so that the Changelogs are your source of truth.
+This project implements a Changelog parser according to the spec at KeepAChangelog. It also provides MSBuild tasks and targets to automate the setting of **Versions** and **Package Release Notes** for your NuGet packages, so that the Changelogs are your source of truth.
 
-## TBDs before release
-
-* [ ] think about how to use CHANGELOG as the source of truth in this project (seems a bit circular now)
+When configured, this package will set the `Version`, `PackageVersion`, and `PackageReleaseNotes` of your packable project with the matching data from the latest Changelog release, as well as adding AssemblyMetadata for the `BuildDate` in the `YYYY-mm-dd` format.
 
 ## Installation
 
 The MSBuild package is authored as a set of tasks and targets that are used automatically.  You just have to install the `Ionide.KeepAChangelog.Tasks` package and you're all set!
 
+```xml
+<ItemGroup>
+    <PackageReference Include="Ionide.KeepAChangelog.Tasks" Version="<insert here>" PrivateAssets="all" />
+</ItemGroup>
+```
+
+## Examples
+
+It might be helpful to see how this library can help you.  Imagine you have a project file like this:
+
+```xml
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <TargetFramework>netstandard2.0</TargetFramework>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+  </PropertyGroup>
+  <ItemGroup>
+    <Compile Include="Main.fs" />
+  </ItemGroup>
+</Project>
+```
+
+and a CHANGELOG.md file like this:
+
+```md
+# Changelog 
+
+## 1.0.0 - 2022-01-14
+
+### Added
+
+* Initial release
+```
+
+packaging the project with this library results in the same result as packing a project that looks like this:
+
+```xml
+<Project Sdk="Microsoft.NET.Sdk">
+ <PropertyGroup>
+   <TargetFramework>netstandard2.0</TargetFramework>
+   <GenerateDocumentationFile>true</GenerateDocumentationFile>
+   <Versions>1.0.0</Versions>
+   <ReleaseNotes>
+## 1.0.0 - 2022-01-14
+
+### Added
+
+* Initial release
+   </ReleaseNotes>
+ </PropertyGroup>
+ <ItemGroup>
+   <Compile Include="Main.fs" />
+ </ItemGroup>
+</Project>
+```
+
+If your changelog has multiple versions, the latest one will be used.
+
 ## Customization
 
 There's really only one property that matters for these targets, and that's `ChangelogFile`. This needs to point to the Changelog file you want to read, but it defaults to `CHANGELOG.md` in the root of a given project in case you want to adhere to defaults.

src/Ionide.KeepAChangelog.Tasks/Ionide.KeepAChangelog.Tasks.fsproj

@@ -8,8 +8,11 @@
     <DebugType>embedded</DebugType>
     <IsPackable>true</IsPackable>
     <Description>MSBuild Tasks and Targets that set your Assembly Version, Package Version, and Package Release Notes from your KeepAChangelog-compatible Changelogs.</Description>
-    <Version>0.1.0</Version>
-    <PackageReleaseNotes>Initial release of the Changelog parsing tasks.</PackageReleaseNotes>
+    <Version>0.1.1</Version>
+    <PackageReleaseNotes>### Added
+
+- Now writes an assembly-level AssemblyMetadataAttribute with the key "BuildDate" whose value is the `YYYY-mm-dd`-formatted date in the release changelog
+</PackageReleaseNotes>
   </PropertyGroup>
 
   <ItemGroup>

src/Ionide.KeepAChangelog.Tasks/build/Ionide.KeepAChangelog.Tasks.targets

@@ -28,6 +28,13 @@
             <PackageVersion>%(CurrentReleaseChangelog.Identity)</PackageVersion>
             <PackageReleaseNotes>@(LatestReleaseNotes)</PackageReleaseNotes>
         </PropertyGroup>
+
+        <ItemGroup Condition="'@(CurrentReleaseChangelog)' != '' and '$(GenerateAssemblyInfo)' == 'true'">
+            <AssemblyAttribute Include="System.Reflection.AssemblyMetadataAttribute" Condition="'$(GenerateRepositoryUrlAttribute)' == 'true' and ('$(RepositoryUrl)' != '' or '$(PublishRepositoryUrl)' == 'true')" >
+                <_Parameter1>BuildDate</_Parameter1>
+                <_Parameter2>%(CurrentReleaseChangelog.Date)</_Parameter2>
+            </AssemblyAttribute>
+        </ItemGroup>
     </Target>
 
 </Project>

src/Ionide.KeepAChangelog/Ionide.KeepAChangelog.fsproj

@@ -6,7 +6,7 @@
     <DebugType>embedded</DebugType>
     <IsPackable>true</IsPackable>
     <Description>A self-contained parser for the KeepAChangelog format.</Description>
-    <Version>0.1.0</Version>
+    <Version>0.1.1</Version>
     <PackageReleaseNotes>Initial release of the KeepAChangelog parser.</PackageReleaseNotes>
   </PropertyGroup>