From d6e7cf06d0a1d61345affc432f2ea6532d9e7f4d Mon Sep 17 00:00:00 2001 From: David Cumps Date: Sun, 12 Mar 2023 01:47:35 +0100 Subject: [PATCH] build: remove docfx (#157) --- README.md | 18 --------- build.fsx | 22 ----------- build.ps1 | 15 ------- build.sh | 19 --------- docs/api/index.md | 1 - docs/articles/index.md | 3 -- docs/articles/toc.yml | 2 - docs/docfx.json | 71 ---------------------------------- docs/images/icon.png | Bin 841 -> 0 bytes docs/index.md | 1 - docs/toc.yml | 6 --- docs/web.config | 8 ---- serve-docs.cmd | 1 - src/Directory.Generated.props | 7 ++-- 14 files changed, 4 insertions(+), 170 deletions(-) delete mode 100644 docs/api/index.md delete mode 100644 docs/articles/index.md delete mode 100644 docs/articles/toc.yml delete mode 100644 docs/docfx.json delete mode 100644 docs/images/icon.png delete mode 100644 docs/index.md delete mode 100644 docs/toc.yml delete mode 100644 docs/web.config delete mode 100644 serve-docs.cmd diff --git a/README.md b/README.md index 41a0f002..9161847e 100644 --- a/README.md +++ b/README.md @@ -432,24 +432,6 @@ The attached build script will automatically do the following based on the conve * Any project name ending with `.Tests` will automatically be treated as a [NBench](https://github.com/petabridge/NBench) project and will be included during the test stages of this build script; and * Any project meeting neither of these conventions will be treated as a NuGet packaging target and its `.nupkg` file will automatically be placed in the `bin\nuget` folder upon running the `build.[cmd|sh] all` command. -### DocFx for Documentation - -This solution also supports [DocFx](http://dotnet.github.io/docfx/) for generating both API documentation and articles to describe the behavior, output, and usages of your project. - -All of the relevant articles you wish to write should be added to the `/docs/articles/` folder and any API documentation you might need will also appear there. - -All of the documentation will be statically generated and the output will be placed in the `/docs/_site/` folder. - -#### Previewing Documentation - -To preview the documentation for this project, execute the following command at the root of this folder: - -``` -C:\> serve-docs.cmd -``` - -This will use the built-in `docfx.console` binary that is installed as part of the NuGet restore process from executing any of the usual `build.cmd` or `build.sh` steps to preview the fully-rendered documentation. For best results, do this immediately after calling `build.cmd buildRelease`. - ### Release Notes, Version Numbers, Etc This project will automatically populate its release notes in all of its modules via the entries written inside [`RELEASE_NOTES.md`](RELEASE_NOTES.md) and will automatically update the versions of all assemblies and NuGet packages via the metadata included inside [`Directory.Build.props`](src/Directory.Build.props). diff --git a/build.fsx b/build.fsx index 2714f891..0037c33c 100644 --- a/build.fsx +++ b/build.fsx @@ -7,7 +7,6 @@ open System.Text open Fake open Fake.DotNetCli -open Fake.DocFxHelper // Information about the project for Nuget and Assembly info files let configuration = "Release" @@ -47,7 +46,6 @@ Target "Clean" (fun _ -> CleanDir outputTests CleanDir outputPerfTests CleanDir outputNuGet - CleanDir "docs/_site" ) Target "AssemblyInfo" (fun _ -> @@ -177,22 +175,6 @@ Target "PublishNuget" (fun _ -> projects |> Seq.iter (runSingleProject) ) -//-------------------------------------------------------------------------------- -// Documentation -//-------------------------------------------------------------------------------- -Target "DocFx" (fun _ -> - DotNetCli.Restore (fun p -> { p with Project = solutionFile }) - DotNetCli.Build (fun p -> { p with Project = solutionFile; Configuration = configuration }) - - let docsPath = "./docs" - - DocFx (fun p -> - { p with - Timeout = TimeSpan.FromMinutes 30.0; - WorkingDirectory = docsPath; - DocFxJson = docsPath @@ "docfx.json" }) -) - //-------------------------------------------------------------------------------- // Cleanup //-------------------------------------------------------------------------------- @@ -218,7 +200,6 @@ Target "Help" <| fun _ -> " * Nuget Create and optionally publish nugets packages" " * RunTests Runs tests" " * All Builds, run tests, creates and optionally publish nuget packages" - " * DocFx Creates a DocFx-based website for this solution" "" " Other Targets" " * Help Display this help" @@ -241,9 +222,6 @@ Target "Nuget" DoNothing "Clean" ==> "Build" ==> "CreateNuget" "CreateNuget" ==> "PublishNuget" ==> "Nuget" -// docs -"Clean" ==> "BuildRelease" ==> "Docfx" - // all "BuildRelease" ==> "All" "RunTests" ==> "All" diff --git a/build.ps1 b/build.ps1 index 834a3aa5..8e93b00a 100644 --- a/build.ps1 +++ b/build.ps1 @@ -32,7 +32,6 @@ Param( $FakeVersion = "4.63.0" $NugetVersion = "5.8.0" $NugetUrl = "https://dist.nuget.org/win-x86-commandline/v$NugetVersion/nuget.exe" -$DocfxVersion = "2.58.9" # Make sure tools folder exists $PSScriptRoot = Split-Path $MyInvocation.MyCommand.Path -Parent @@ -67,20 +66,6 @@ if (!(Test-Path $FakeExePath)) { } } -########################################################################### -# Docfx -########################################################################### - -# Make sure Docfx has been installed. -$DocfxExePath = Join-Path $ToolPath "docfx.console/tools/docfx.exe" -if (!(Test-Path $DocfxExePath)) { - Write-Host "Installing Docfx..." - Invoke-Expression "&`"$NugetPath`" install docfx.console -ExcludeVersion -Version $DocfxVersion -OutputDirectory `"$ToolPath`"" | Out-Null; - if ($LASTEXITCODE -ne 0) { - Throw "An error occured while restoring docfx.console from NuGet." - } -} - ########################################################################### # RUN BUILD SCRIPT ########################################################################### diff --git a/build.sh b/build.sh index 86c0824b..9250417f 100644 --- a/build.sh +++ b/build.sh @@ -10,8 +10,6 @@ NUGET_EXE=$TOOLS_DIR/nuget.exe NUGET_URL=https://dist.nuget.org/win-x86-commandline/v5.8.0/nuget.exe FAKE_VERSION=4.63.0 FAKE_EXE=$TOOLS_DIR/FAKE/tools/FAKE.exe -DOCFX_VERSION=2.58.9 -DOCFX_EXE=$TOOLS_DIR/docfx.console/tools/docfx.exe # Define default arguments. TARGET="Default" @@ -70,23 +68,6 @@ if [ ! -f "$FAKE_EXE" ]; then exit 1 fi -########################################################################### -# INSTALL DOCFX -########################################################################### -if [ ! -f "$DOCFX_EXE" ]; then - mono "$NUGET_EXE" install docfx.console -ExcludeVersion -Version $DOCFX_VERSION -OutputDirectory "$TOOLS_DIR" - if [ $? -ne 0 ]; then - echo "An error occured while installing DocFx." - exit 1 - fi -fi - -# Make sure that DocFx has been installed. -if [ ! -f "$DOCFX_EXE" ]; then - echo "Could not find docfx.exe at '$DOCFX_EXE'." - exit 1 -fi - ########################################################################### # WORKAROUND FOR MONO ########################################################################### diff --git a/docs/api/index.md b/docs/api/index.md deleted file mode 100644 index 9e0155be..00000000 --- a/docs/api/index.md +++ /dev/null @@ -1 +0,0 @@ -# API Docs \ No newline at end of file diff --git a/docs/articles/index.md b/docs/articles/index.md deleted file mode 100644 index 9d45024d..00000000 --- a/docs/articles/index.md +++ /dev/null @@ -1,3 +0,0 @@ -# Introduction - -Article text goes here. \ No newline at end of file diff --git a/docs/articles/toc.yml b/docs/articles/toc.yml deleted file mode 100644 index 4262931e..00000000 --- a/docs/articles/toc.yml +++ /dev/null @@ -1,2 +0,0 @@ -- name: Introduction - href: index.md \ No newline at end of file diff --git a/docs/docfx.json b/docs/docfx.json deleted file mode 100644 index 79eda640..00000000 --- a/docs/docfx.json +++ /dev/null @@ -1,71 +0,0 @@ -{ - "metadata": [ - { - "src": [ - { - "files": [ "**/*.csproj" ], - "exclude": [ - "**/obj/**", - "**/bin/**", - "_site/**", - "**/*Tests*.csproj", - "**/*Tests.*.csproj" - ], - "src": "../src" - } - ], - "dest": "api" - } - ], - "build": { - "content": [ - { - "files": [ - "api/**.yml", - "api/index.md" - ] - }, - { - "files": [ - "articles/**.md", - "articles/**/toc.yml", - "toc.yml", - "*.md" - ], - "exclude": [ - "obj/**", - "_site/**" - ] - }, - ], - "resource": [ - { - "files": [ - "images/**", - "web.config", - ], - "exclude": [ - "obj/**", - "_site/**" - ] - } - ], - "sitemap": { - "baseUrl": "https://yoursite.github.io/" - }, - "dest": "_site", - "globalMetadata": { - "_appTitle": "Akka.Persistence.Linq2Db", - "_disableContribution": "true", - "_appLogoPath": "/images/icon.png", - }, - "globalMetadataFiles": [], - "fileMetadataFiles": [], - "template": [ - "default", - "template" - ], - "postProcessors": ["ExtractSearchIndex"], - "noLangKeyword": false - } -} \ No newline at end of file diff --git a/docs/images/icon.png b/docs/images/icon.png deleted file mode 100644 index 86698cd6d92eabd00b206f56d4ffbfa59be23a15..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 841 zcmeAS@N?(olHy`uVBq!ia0vp^Q6S901|%(3I5Gh##^NA%Cx&(BWL^R}Ea{HEjtmSN z`?>!lvI6;>1s;*b3=DjSL74G){)!Z!pk#?_L`iUdT1k0gQ7S`0VrE{6US4X6f{C7i zo}syM-uz?+2Bw{!E{-7;ac{5NW`{UR9Q`O@&}AkS*rKqawL^u4m9yj61Mk#C(Wa)K zY?*KVF#Y1>;fVT?C&0Z?pjmLSMwgh|h7B9GZr&_7@vF`09-p@2-IG@roM*N-`aJ)% z*kiTbd|#?;vl)Arxi5ZsF{8?4mK<%FH`vbjNn~0`H#%?F_^`&<=fJ(T&tEqzf7tVF zt6Q?P!S@HLSNjfzcleg=x46&NAAG*<@X=SLc}q6`Ts7Z!?my;rs#3QbB1Y>BqevxWR9=1&bDQ>F<*);m<9co+`hyQ%-Z><4bDGE zJABi#!{&OqV{rl#NtG}bpBkK>0H~5x6Wd8C$xvBI04f%&0JO}G`a1~bUs93w>MX3Co z8QKEf7w&fZy|t)ms!_cEAgFL3>m#9hhq`CFGHc?Vi(L`7< - - - - - - - \ No newline at end of file diff --git a/serve-docs.cmd b/serve-docs.cmd deleted file mode 100644 index fa428613..00000000 --- a/serve-docs.cmd +++ /dev/null @@ -1 +0,0 @@ -PowerShell.exe -file "serve-docs.ps1" %* .\docs\docfx.json --serve -p 8090 \ No newline at end of file diff --git a/src/Directory.Generated.props b/src/Directory.Generated.props index 80d9e4ed..1663edbc 100644 --- a/src/Directory.Generated.props +++ b/src/Directory.Generated.props @@ -1,6 +1,7 @@ - 0.0.1 - Placeholder + 1.4.28 + Perf Enhancements and fixes to failure reporting** +There was an issue found where persistence failures were being reported as rejections when they should not have. This has been fixed alongside some logic cleanup that should lead to more consistent performance. - + \ No newline at end of file