Skip to content

Commit

Permalink
Update README.md 📚
Browse files Browse the repository at this point in the history
  • Loading branch information
Freymaurer committed Feb 8, 2021
1 parent 819179e commit b0216ab
Show file tree
Hide file tree
Showing 5 changed files with 38 additions and 30 deletions.
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,27 +57,34 @@ While testing i ran into some erros that you might also encounter:
- When using BlackFox.Fake.BuildTask make sure to reference `BuildTask.runOrDefaultWithArguments defaultTask` at the bottom of .fsx. When running standard Fake reference `Target.runOrDefaultWithArguments defaultTarget`. This is necessary as the several `ReleaseNotes.FAKE` targets take additional parameters.

```fsharp
open Fake.Extensions.Release
module ProjectInfo =
let gitOwner = "Freymaurer"
let gitName = "Fake.Extensions.Release"
```

```fsharp
module ReleaseNoteTasks =
open Fake.Extensions.Release
let createAssemblyVersion = BuildTask.create "createvfs" [] {
AssemblyVersion.create "ReleaseNotes.FAKE"
AssemblyVersion.create ProjectInfo.gitName
}
let updateReleaseNotes = BuildTask.createFn "ReleaseNotes" [] (fun config ->
Release.exists()
Release.update "Freymaurer" "Fake.Extensions.Release" config
Release.update(ProjectInfo.gitOwner, ProjectInfo.gitName, config)
)
let githubDraft = BuildTask.createFn "GithubDraft" [] (fun config ->
let body = "We are ready to go for the first release!"
Github.draft(
"Freymaurer",
"ReleaseNotes.FAKE",
ProjectInfo.gitOwner,
ProjectInfo.gitName,
(Some body),
None,
config
Expand Down
9 changes: 5 additions & 4 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
### 0.2.0+55dc4b9 (Released 2021-2-8)
### 0.2.0+819179e (Released 2021-2-8)
* Additions:
* latest commit #55dc4b9
* latest commit #819179e
* [[#bc4553d](https://github.com/nfdi4plants/Swate/commit/bc4553d438bc76a662048bae705116b60dd91839)] Update README.md :books:
* [[#55dc4b9](https://github.com/nfdi4plants/Swate/commit/55dc4b9ba64eaf676809436f0e69f4a9106fa729)] Change library namespace (Issue #1)
* [[#55dc4b9](https://github.com/nfdi4plants/Swate/commit/55dc4b9ba64eaf676809436f0e69f4a9106fa729)] Change library namespace (Issue #1).
* Bugfixes:
* [[#9598d25](https://github.com/nfdi4plants/Swate/commit/9598d25f00a4876e789a1e8d05919014feca3b03)] Fix hardcoded commit url (Issue #2)
* [[#819179e](https://github.com/nfdi4plants/Swate/commit/819179eeb712cfbd2ebbecb6ad33fb35e371d085)] Fix nuget package release notes.
* [[#9598d25](https://github.com/nfdi4plants/Swate/commit/9598d25f00a4876e789a1e8d05919014feca3b03)] Fix hardcoded commit url (Issue #2).

### 0.1.0+510d781 (Released 2021-2-6)
* Additions:
Expand Down
14 changes: 7 additions & 7 deletions build.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,14 @@ nuget Fake.DotNet.Fsi
nuget Fake.DotNet.NuGet
nuget Fake.Api.Github
nuget Fake.DotNet.Testing.Expecto
nuget ReleaseNotes.FAKE
nuget Fake.Extensions.Release
nuget Fake.Tools.Git //"

#if !FAKE
#load "./.fake/build.fsx/intellisense.fsx"
#r "netstandard" // Temp fix for https://github.com/dotnet/fsharp/issues/5216
#endif

open ReleaseNotes.FAKE

open BlackFox.Fake
open System.IO
open Fake.Core
Expand Down Expand Up @@ -381,21 +379,23 @@ module ReleaseTasks =

module ReleaseNoteTasks =

open Fake.Extensions.Release

let createAssemblyVersion = BuildTask.create "createvfs" [] {
ReleaseNotes.FAKE.AssemblyVersion.create ProjectInfo.gitName
AssemblyVersion.create ProjectInfo.gitName
}

let updateReleaseNotes = BuildTask.createFn "ReleaseNotes" [] (fun config ->
ReleaseNotes.FAKE.Release.exists()
Release.exists()

ReleaseNotes.FAKE.Release.update config
Release.update(ProjectInfo.gitOwner, ProjectInfo.gitName, config)
)

let githubDraft = BuildTask.createFn "GithubDraft" [] (fun config ->

let body = "We are ready to go for the first release!"

ReleaseNotes.FAKE.Github.draft(
Github.draft(
ProjectInfo.gitOwner,
ProjectInfo.gitName,
(Some body),
Expand Down
18 changes: 9 additions & 9 deletions build.fsx.lock
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,15 @@ NUGET
Fake.IO.FileSystem (>= 5.20.3)
Fake.Testing.Common (>= 5.20.3)
FSharp.Core (>= 4.7.2)
Fake.Extensions.Release (0.2)
Fake.Api.GitHub (>= 5.20.3)
Fake.Core.ReleaseNotes (>= 5.20.3)
Fake.Core.Target (>= 5.20.3)
Fake.DotNet.AssemblyInfoFile (>= 5.20.3)
Fake.IO.FileSystem (>= 5.20.3)
Fake.IO.Zip (>= 5.20.3)
Fake.Tools.Git (>= 5.20.3)
FSharp.Core (>= 5.0)
Fake.IO.FileSystem (5.20.3)
Fake.Core.String (>= 5.20.3)
FSharp.Core (>= 4.7.2)
Expand Down Expand Up @@ -235,15 +244,6 @@ NUGET
NuGet.Packaging (>= 5.8.1)
NuGet.Versioning (5.8.1)
Octokit (0.48)
ReleaseNotes.FAKE (0.0.2-alpha1)
Fake.Api.GitHub (>= 5.20.3)
Fake.Core.ReleaseNotes (>= 5.20.3)
Fake.Core.Target (>= 5.20.3)
Fake.DotNet.AssemblyInfoFile (>= 5.20.3)
Fake.IO.FileSystem (>= 5.20.3)
Fake.IO.Zip (>= 5.20.3)
Fake.Tools.Git (>= 5.20.3)
FSharp.Core (>= 5.0)
runtime.debian.8-x64.runtime.native.System.Security.Cryptography.OpenSsl (4.3.3)
runtime.debian.9-x64.runtime.native.System.Security.Cryptography.OpenSsl (4.3.3)
runtime.fedora.23-x64.runtime.native.System.Security.Cryptography.OpenSsl (4.3.3)
Expand Down
8 changes: 4 additions & 4 deletions src/Fake.Extensions.Release/Fake.Extensions.Release.fsproj
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,11 @@
<PackageLicenseExpression>MIT</PackageLicenseExpression>
<!--<PackageProjectUrl>https://fslab.org/docs-template/</PackageProjectUrl>-->
<!--<PackageIconUrl>https://fslab.org/docs-template/img/logo.png</PackageIconUrl>-->
<PackageTags>release-notes fsharp fake dotnet</PackageTags>
<RepositoryUrl>https://github.com/Freymaurer/ReleaseNotes.FAKE</RepositoryUrl>
<PackageTags>release-notes fake fsharp dotnet</PackageTags>
<RepositoryUrl>https://github.com/Freymaurer/Fake.Extensions.Release</RepositoryUrl>
<RepositoryType>git</RepositoryType>
<FsDocsLicenseLink>https://github.com/Freymaurer/ReleaseNotes.FAKE/blob/main/LICENSE</FsDocsLicenseLink>
<FsDocsReleaseNotesLink>https://github.com/Freymaurer/ReleaseNotes.FAKE/blob/main/RELEASE_NOTES.md</FsDocsReleaseNotesLink>
<FsDocsLicenseLink>https://github.com/Freymaurer/Fake.Extensions.Release/blob/main/LICENSE</FsDocsLicenseLink>
<FsDocsReleaseNotesLink>https://github.com/Freymaurer/Fake.Extensions.Release/blob/main/RELEASE_NOTES.md</FsDocsReleaseNotesLink>
</PropertyGroup>

</Project>

0 comments on commit b0216ab

Please sign in to comment.