Add docs, test and finetune :spakles:

nfdi4plants · Sep 2, 2022 · 5463c1e · 5463c1e
1 parent 82c70db
commit 5463c1e
Show file tree

Hide file tree

Showing 7 changed files with 45 additions and 497 deletions.
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -1,3 +1,10 @@
+### 0.7.0+82c70db (Released 2022-9-2)
+* Additions:
+    * latest commit #82c70db
+    * [[#82c70db](https://github.com/Freymaurer/Nfdi4Plants.Fornax/commit/82c70db2230748e7c7ad90670626baae8b29f297)] Set up template
+* Bugfixes:
+    * [[#0103166](https://github.com/Freymaurer/Nfdi4Plants.Fornax/commit/010316603977c958e244b160dce4ba36010caafe)] Fix test project dependencies :bug:
+
 ### 0.6.0+61e662d (Released 2022-7-15)
 * Additions:
     * latest commit #61e662d

diff --git a/build/ReleaseNotesTasks.fs b/build/ReleaseNotesTasks.fs
@@ -11,6 +11,16 @@ let updateReleaseNotes = BuildTask.createFn "ReleaseNotes" [] (fun config ->
     Release.exists()
 
     Release.update(ProjectInfo.gitOwner, ProjectInfo.project, config)
+
+    let semVer = 
+        Fake.Core.ReleaseNotes.load "RELEASE_NOTES.md"
+        |> fun x -> x.SemVer.AsString
+
+    // Update Version in src/Nfdi4Plants.Fornax.Template/package.json
+    let p = "src/Nfdi4Plants.Fornax.Template/content/package.json"
+    let t = System.IO.File.ReadAllText p
+    let tNew = System.Text.RegularExpressions.Regex.Replace(t, """\"version\": \".*\",""", sprintf "\"version\": \"%s\"," semVer )
+    System.IO.File.WriteAllText(p, tNew)
 )
 
 let githubDraft = BuildTask.createFn "GithubDraft" [] (fun config ->

diff --git a/src/Nfdi4Plants.Fornax.Template/content/README.md b/src/Nfdi4Plants.Fornax.Template/content/README.md
@@ -1,2 +1,28 @@
 # Nfdi4Plants.Fornax.Template
 
+After initializing this template please run the following commands to get started:
+
+1. `dotnet tool restore`, will restore local dotnet tools _fornax_ and _paket_.
+2. `dotnet paket install`, will download the Nfdi4Plants.Fornax library.
+3. `cd src` -> `dotnet fornax watch`
+
+Done! 🎉 You can now open your static website on http://127.0.0.1:8080
+
+## Docs 
+
+Check out the docs for usage [here](https://nfdi4plants.github.io/web-components-docs/docs/SupportedStaticSiteGenerators.html#fornax).
+
+## Update @nfdi4plants/web-components 
+
+_Might need to install rollup globally before._
+
+1. `npm install @nfdi4plants/web-components@latest`
+2. `rollup --config rollup.config.js`
+
+## Update Nfdi4Plants.Fornax
+
+`dotnet paket update Nfdi4Plants.Fornax`
+
+## Schedule automatic updates for gh-pages
+
+See [here](https://nfdi4plants.github.io/web-components-docs/docs/ScheduledUpdates.html).