diff --git a/.gitignore b/.gitignore index eb5bece3..d06de2ac 100644 --- a/.gitignore +++ b/.gitignore @@ -259,11 +259,6 @@ tests/integration/repos/ Source/Cake.Recipe/Content/version.cake includes.cake -# Wyam related -docs/config.wyam.dll -docs/config.wyam.hash -docs/config.wyam.packages.xml - *.orig .DS_Store diff --git a/.vscode/settings.json b/.vscode/settings.json index 75ee04e7..bd5d4801 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -17,7 +17,6 @@ "Transifex", "Veyor", "WEBHOOKURL", - "Wyam", "Xunit", "bootstrapper", "cakecontrib", diff --git a/Source/Cake.Recipe/Content/addins.cake b/Source/Cake.Recipe/Content/addins.cake index 4a32fa31..88f02945 100644 --- a/Source/Cake.Recipe/Content/addins.cake +++ b/Source/Cake.Recipe/Content/addins.cake @@ -8,12 +8,10 @@ #addin nuget:?package=Portable.BouncyCastle&version=1.8.5 #addin nuget:?package=Cake.Email&version=2.0.0&loaddependencies=true #addin nuget:?package=Cake.Incubator&version=8.0.0 -#addin nuget:?package=Cake.Kudu&version=3.0.0 #addin nuget:?package=Cake.MicrosoftTeams&version=2.0.0 #addin nuget:?package=Cake.Slack&version=2.0.0 #addin nuget:?package=Cake.Transifex&version=2.0.0 #addin nuget:?package=Cake.Twitter&version=3.0.0 -#addin nuget:?package=Cake.Wyam&version=2.2.14 #addin nuget:?package=Cake.Mastodon&version=1.1.0 #load nuget:?package=Cake.Issues.Recipe&version=3.1.1 diff --git a/Source/Cake.Recipe/Content/credentials.cake b/Source/Cake.Recipe/Content/credentials.cake index 7bfc94ae..9111c3b6 100644 --- a/Source/Cake.Recipe/Content/credentials.cake +++ b/Source/Cake.Recipe/Content/credentials.cake @@ -122,20 +122,6 @@ public class TransifexCredentials : AppVeyorCredentials } } -public class WyamCredentials -{ - public string AccessToken { get; private set; } - public string DeployRemote { get; private set; } - public string DeployBranch { get; private set; } - - public WyamCredentials(string accessToken, string deployRemote, string deployBranch) - { - AccessToken = accessToken; - DeployRemote = deployRemote; - DeployBranch = deployBranch; - } -} - public class MastodonCredentials { public string AccessToken { get; private set; } @@ -229,14 +215,6 @@ public static TransifexCredentials GetTransifexCredentials(ICakeContext context) ); } -public static WyamCredentials GetWyamCredentials(ICakeContext context) -{ - return new WyamCredentials( - context.EnvironmentVariable(Environment.WyamAccessTokenVariable), - context.EnvironmentVariable(Environment.WyamDeployRemoteVariable), - context.EnvironmentVariable(Environment.WyamDeployBranchVariable)); -} - public static MastodonCredentials GetMastodonCredentials(ICakeContext context) { return new MastodonCredentials( diff --git a/Source/Cake.Recipe/Content/documentation.cake b/Source/Cake.Recipe/Content/documentation.cake new file mode 100644 index 00000000..b12ded63 --- /dev/null +++ b/Source/Cake.Recipe/Content/documentation.cake @@ -0,0 +1,38 @@ +/////////////////////////////////////////////////////////////////////////////// +// TASK DEFINITIONS +/////////////////////////////////////////////////////////////////////////////// + +BuildParameters.Tasks.CleanDocumentationTask = Task("Clean-Documentation") + .Does(() => +{ + Information("This task is intentionally left empty until a replacement tool is selected."); +}); + +BuildParameters.Tasks.PublishDocumentationTask = Task("Publish-Documentation") + .IsDependentOn("Clean-Documentation") + .WithCriteria(() => BuildParameters.ShouldGenerateDocumentation, "Documentation has been disabled") + .Does(() => + { + Information("This task is intentionally left empty until a replacement tool is selected."); + } +) +.OnError(exception => +{ + Error(exception.Message); + Information("Publish-Documentation Task failed, but continuing with next Task..."); + publishingError = true; +}); + +BuildParameters.Tasks.PreviewDocumentationTask = Task("Preview-Documentation") + .Does(() => + { + Information("This task is intentionally left empty until a replacement tool is selected."); + } +); + +BuildParameters.Tasks.ForcePublishDocumentationTask = Task("Force-Publish-Documentation") + .IsDependentOn("Clean-Documentation") + .Does(() => { + Information("This task is intentionally left empty until a replacement tool is selected."); + } +); \ No newline at end of file diff --git a/Source/Cake.Recipe/Content/environment.cake b/Source/Cake.Recipe/Content/environment.cake index bc13976a..0e1b8b63 100644 --- a/Source/Cake.Recipe/Content/environment.cake +++ b/Source/Cake.Recipe/Content/environment.cake @@ -17,9 +17,6 @@ public static class Environment public static string CoverallsRepoTokenVariable { get; private set; } public static string MicrosoftTeamsWebHookUrlVariable { get; private set; } public static string TransifexApiTokenVariable { get; private set; } - public static string WyamAccessTokenVariable { get; private set; } - public static string WyamDeployRemoteVariable { get; private set; } - public static string WyamDeployBranchVariable { get; private set; } public static string MastodonAccessTokenVariable { get; private set; } public static string MastodonInstanceUrlVariable { get; private set; } @@ -41,9 +38,6 @@ public static class Environment string coverallsRepoTokenVariable = null, string microsoftTeamsWebHookUrlVariable = null, string transifexApiTokenVariable = null, - string wyamAccessTokenVariable = null, - string wyamDeployRemoteVariable = null, - string wyamDeployBranchVariable = null, string mastodonAccessTokenVariable = null, string mastodonInstanceUrlVariable = null) { @@ -64,9 +58,6 @@ public static class Environment CoverallsRepoTokenVariable = coverallsRepoTokenVariable ?? "COVERALLS_REPO_TOKEN"; MicrosoftTeamsWebHookUrlVariable = microsoftTeamsWebHookUrlVariable ?? "MICROSOFTTEAMS_WEBHOOKURL"; TransifexApiTokenVariable = transifexApiTokenVariable ?? "TRANSIFEX_API_TOKEN"; - WyamAccessTokenVariable = wyamAccessTokenVariable ?? "WYAM_ACCESS_TOKEN"; - WyamDeployRemoteVariable = wyamDeployRemoteVariable ?? "WYAM_DEPLOY_REMOTE"; - WyamDeployBranchVariable = wyamDeployBranchVariable ?? "WYAM_DEPLOY_BRANCH"; MastodonAccessTokenVariable = mastodonAccessTokenVariable ?? "MASTODON_ACCESS_TOKEN"; MastodonInstanceUrlVariable = mastodonInstanceUrlVariable ?? "MASTODON_INSTANCE_URL"; } diff --git a/Source/Cake.Recipe/Content/parameters.cake b/Source/Cake.Recipe/Content/parameters.cake index 8fd655bc..69dd5f40 100644 --- a/Source/Cake.Recipe/Content/parameters.cake +++ b/Source/Cake.Recipe/Content/parameters.cake @@ -64,7 +64,6 @@ public static class BuildParameters public static CodecovCredentials Codecov { get; private set; } public static CoverallsCredentials Coveralls { get; private set; } public static TransifexCredentials Transifex { get; private set; } - public static WyamCredentials Wyam { get; private set; } public static BuildPaths Paths { get; private set; } public static BuildTasks Tasks { get; set; } public static DirectoryPath RootDirectoryPath { get; private set; } @@ -111,16 +110,6 @@ public static class BuildParameters } } - public static DirectoryPath WyamRootDirectoryPath { get; private set; } - public static DirectoryPath WyamPublishDirectoryPath { get; private set; } - public static FilePath WyamConfigurationFile { get; private set; } - public static string WyamRecipe { get; private set; } - public static string WyamTheme { get; private set; } - public static string WyamSourceFiles { get; private set; } - public static string WebHost { get; private set; } - public static string WebLinkRoot { get; private set; } - public static string WebBaseEditUrl { get; private set; } - public static FilePath NuSpecFilePath { get; private set; } public static FilePath NugetConfig { get; private set; } @@ -143,16 +132,6 @@ public static class BuildParameters } } - public static bool CanUseWyam - { - get - { - return !string.IsNullOrEmpty(BuildParameters.Wyam.AccessToken) && - !string.IsNullOrEmpty(BuildParameters.Wyam.DeployRemote) && - !string.IsNullOrEmpty(BuildParameters.Wyam.DeployBranch); - } - } - public static bool CanPublishToCodecov { get @@ -236,17 +215,6 @@ public static class BuildParameters context.Information("TransifexPullPercentage: {0}", TransifexPullPercentage); } - context.Information("WyamRootDirectoryPath: {0}", WyamRootDirectoryPath); - context.Information("WyamPublishDirectoryPath: {0}", WyamPublishDirectoryPath); - context.Information("WyamConfigurationFile: {0}", WyamConfigurationFile); - context.Information("WyamRecipe: {0}", WyamRecipe); - context.Information("WyamTheme: {0}", WyamTheme); - context.Information("WyamSourceFiles: {0}", WyamSourceFiles); - context.Information("Wyam Deploy Branch: {0}", Wyam.DeployBranch); - context.Information("Wyam Deploy Remote: {0}", Wyam.DeployRemote); - context.Information("WebHost: {0}", WebHost); - context.Information("WebLinkRoot: {0}", WebLinkRoot); - context.Information("WebBaseEditUrl: {0}", WebBaseEditUrl); context.Information("NuSpecFilePath: {0}", NuSpecFilePath); context.Information("NugetConfig: {0} ({1})", NugetConfig, context.FileExists(NugetConfig)); context.Information("NuGetSources: {0}", string.Join(", ", NuGetSources)); @@ -299,15 +267,6 @@ public static class BuildParameters int transifexPullPercentage = 60, string microsoftTeamsMessage = null, string twitterMessage = null, - DirectoryPath wyamRootDirectoryPath = null, - DirectoryPath wyamPublishDirectoryPath = null, - FilePath wyamConfigurationFile = null, - string wyamRecipe = null, - string wyamTheme = null, - string wyamSourceFiles = null, - string webHost = null, - string webLinkRoot = null, - string webBaseEditUrl = null, FilePath nuspecFilePath = null, bool isPublicRepository = true, FilePath nugetConfig = null, @@ -363,16 +322,6 @@ public static class BuildParameters TransifexPullMode = transifexPullMode; TransifexPullPercentage = transifexPullPercentage; - WyamRootDirectoryPath = wyamRootDirectoryPath ?? context.MakeAbsolute(context.Directory("docs")); - WyamPublishDirectoryPath = wyamPublishDirectoryPath ?? context.MakeAbsolute(context.Directory("BuildArtifacts/temp/_PublishedDocumentation")); - WyamConfigurationFile = wyamConfigurationFile ?? context.MakeAbsolute((FilePath)"config.wyam"); - WyamRecipe = wyamRecipe ?? "Docs"; - WyamTheme = wyamTheme ?? "Samson"; - WyamSourceFiles = wyamSourceFiles ?? "../../" + SourceDirectoryPath.FullPath + "/**/{!bin,!obj,!packages,!*.Tests,}/**/*.cs"; - WebHost = webHost ?? string.Format("{0}.github.io", repositoryOwner); - WebLinkRoot = webLinkRoot ?? RepositoryName; - WebBaseEditUrl = webBaseEditUrl ?? string.Format("https://github.com/{0}/{1}/tree/{2}/docs/input/", repositoryOwner, RepositoryName, developBranchName); - ShouldDownloadFullReleaseNotes = shouldDownloadFullReleaseNotes; ShouldDownloadMilestoneReleaseNotes = shouldDownloadMilestoneReleaseNotes; ShouldNotifyBetaReleases = shouldNotifyBetaReleases; @@ -517,7 +466,6 @@ public static class BuildParameters Codecov = GetCodecovCredentials(context); Coveralls = GetCoverallsCredentials(context); Transifex = GetTransifexCredentials(context); - Wyam = GetWyamCredentials(context); IsPublishBuild = new [] { "Create-Release-Notes" }.Any( diff --git a/Source/Cake.Recipe/Content/toolsettings.cake b/Source/Cake.Recipe/Content/toolsettings.cake index 23875b17..257aac12 100644 --- a/Source/Cake.Recipe/Content/toolsettings.cake +++ b/Source/Cake.Recipe/Content/toolsettings.cake @@ -19,8 +19,6 @@ public static class ToolSettings public static string GitReleaseManagerTool { get; private set; } public static string GitVersionTool { get; private set; } public static string ReSharperTools { get; private set; } - public static string KuduSyncTool { get; private set; } - public static string WyamTool { get; private set; } public static string XUnitTool { get; private set; } public static string NUnitTool { get; private set; } public static string NuGetTool { get; private set; } @@ -34,8 +32,6 @@ public static class ToolSettings public static string GitReleaseManagerGlobalTool { get; private set; } public static string GitVersionGlobalTool { get; private set; } public static string ReportGeneratorGlobalTool { get; private set; } - public static string WyamGlobalTool { get; private set; } - public static string KuduSyncGlobalTool { get; private set; } public static void SetToolPreprocessorDirectives( string codecovTool = "#tool nuget:?package=CodecovUploader&version=0.8.0", @@ -45,8 +41,6 @@ public static class ToolSettings // This is specifically pinned to 5.0.1 as later versions break compatibility with Unix. string gitVersionTool = "#tool nuget:?package=GitVersion.CommandLine&version=5.0.1", string reSharperTools = "#tool nuget:?package=JetBrains.ReSharper.CommandLineTools&version=2025.2.2.1", - string kuduSyncTool = "#tool nuget:?package=KuduSync.NET&version=1.5.4", - string wyamTool = "#tool nuget:?package=Wyam&version=2.2.9", string xunitTool = "#tool nuget:?package=xunit.runner.console&version=2.9.3", string nunitTool = "#tool nuget:?package=NUnit.ConsoleRunner&version=3.20.1", string nugetTool = "#tool nuget:?package=NuGet.CommandLine&version=6.14.0", @@ -57,10 +51,7 @@ public static class ToolSettings string coverallsGlobalTool = "#tool dotnet:?package=coveralls.net&version=1.0.0", string gitReleaseManagerGlobalTool = "#tool dotnet:?package=GitReleaseManager.Tool&version=0.20.0", string gitVersionGlobalTool = "#tool dotnet:?package=GitVersion.Tool&version=5.12.0", - string reportGeneratorGlobalTool = "#tool dotnet:?package=dotnet-reportgenerator-globaltool&version=4.8.5", - string wyamGlobalTool = "#tool dotnet:?package=Wyam.Tool&version=2.2.9", - // This is using an unofficial build of kudusync so that we can have a .NET Global tool version. This was generated from this PR: https://github.com/projectkudu/KuduSync.NET/pull/27 - string kuduSyncGlobalTool = "#tool dotnet:https://www.myget.org/F/cake-contrib/api/v3/index.json?package=KuduSync.Tool&version=1.5.4-g3916ad7218" + string reportGeneratorGlobalTool = "#tool dotnet:?package=dotnet-reportgenerator-globaltool&version=4.8.5" ) { CodecovTool = codecovTool; @@ -68,8 +59,6 @@ public static class ToolSettings GitReleaseManagerTool = gitReleaseManagerTool; GitVersionTool = gitVersionTool; ReSharperTools = reSharperTools; - KuduSyncTool = kuduSyncTool; - WyamTool = wyamTool; XUnitTool = xunitTool; NUnitTool = nunitTool; NuGetTool = nugetTool; @@ -81,8 +70,6 @@ public static class ToolSettings GitReleaseManagerGlobalTool = gitReleaseManagerGlobalTool; CodecovGlobalTool = codecovGlobalTool; CoverallsGlobalTool = coverallsGlobalTool; - WyamGlobalTool = wyamGlobalTool; - KuduSyncGlobalTool = kuduSyncGlobalTool; } public static void SetToolSettings( diff --git a/Source/Cake.Recipe/Content/wyam.cake b/Source/Cake.Recipe/Content/wyam.cake deleted file mode 100644 index f16b736c..00000000 --- a/Source/Cake.Recipe/Content/wyam.cake +++ /dev/null @@ -1,202 +0,0 @@ -/////////////////////////////////////////////////////////////////////////////// -// TASK DEFINITIONS -/////////////////////////////////////////////////////////////////////////////// - -BuildParameters.Tasks.CleanDocumentationTask = Task("Clean-Documentation") - .Does(() => -{ - EnsureDirectoryExists(BuildParameters.WyamPublishDirectoryPath); -}); - -BuildParameters.Tasks.PublishDocumentationTask = Task("Publish-Documentation") - .IsDependentOn("Clean-Documentation") - .WithCriteria(() => BuildParameters.ShouldGenerateDocumentation, "Wyam documentation has been disabled") - .WithCriteria(() => DirectoryExists(BuildParameters.WyamRootDirectoryPath), "Wyam documentation directory is missing") - .Does(() => RequireTool(BuildParameters.IsDotNetBuild ? ToolSettings.WyamGlobalTool : ToolSettings.WyamTool, () => { - // Check to see if any documentation has changed - var sourceCommit = GitLogTip("./"); - Information("Source Commit Sha: {0}", sourceCommit.Sha); - var filesChanged = GitDiff("./", sourceCommit.Sha); - Information("Number of changed files: {0}", filesChanged.Count); - var docFileChanged = false; - - var wyamDocsFolderDirectoryName = BuildParameters.WyamRootDirectoryPath.GetDirectoryName(); - - var pathsToTestAgainst = new List() { - string.Format("{0}{1}", wyamDocsFolderDirectoryName, '/') - }; - - if (BuildParameters.ShouldDocumentSourceFiles) - { - // BuildParameters.WyamSourceFiles can not be used - the wyam globs are different from globs in GetFiles(). - pathsToTestAgainst.Add(string.Format("{0}{1}", BuildParameters.SourceDirectoryPath.FullPath, '/')); - } - - Verbose("Comparing all file-changes to the following paths:"); - foreach(var p in pathsToTestAgainst) - { - Verbose(" - "+p); - } - - foreach (var file in filesChanged) - { - Verbose("Changed File OldPath: {0}, Path: {1}", file.OldPath, file.Path); - if (pathsToTestAgainst.Any(x => file.OldPath.Contains(x) || file.Path.Contains(x)) || - file.Path.Contains("config.wyam")) - { - docFileChanged = true; - break; - } - } - - if (docFileChanged) - { - Information("Detected that documentation files have changed, so running Wyam..."); - var settings = new Dictionary - { - { "Host", BuildParameters.WebHost }, - { "LinkRoot", BuildParameters.WebLinkRoot }, - { "BaseEditUrl", BuildParameters.WebBaseEditUrl }, - { "Title", BuildParameters.Title }, - { "IncludeGlobalNamespace", false } - }; - - if (BuildParameters.ShouldDocumentSourceFiles) - { - settings.Add("SourceFiles", BuildParameters.WyamSourceFiles); - } - - Wyam(new WyamSettings - { - Recipe = BuildParameters.WyamRecipe, - Theme = BuildParameters.WyamTheme, - OutputPath = MakeAbsolute(BuildParameters.Paths.Directories.PublishedDocumentation), - RootPath = BuildParameters.WyamRootDirectoryPath, - ConfigurationFile = BuildParameters.WyamConfigurationFile, - PreviewVirtualDirectory = BuildParameters.WebLinkRoot, - Settings = settings - }); - - PublishDocumentation(); - } - else - { - Information("No documentation has changed, so no need to generate documentation"); - } - }) -) -.OnError(exception => -{ - Error(exception.Message); - Information("Publish-Documentation Task failed, but continuing with next Task..."); - publishingError = true; -}); - -BuildParameters.Tasks.PreviewDocumentationTask = Task("Preview-Documentation") - .WithCriteria(() => DirectoryExists(BuildParameters.WyamRootDirectoryPath), "Wyam documentation directory is missing") - .Does(() => RequireTool(BuildParameters.IsDotNetBuild ? ToolSettings.WyamGlobalTool : ToolSettings.WyamTool, () => { - var settings = new Dictionary - { - { "Host", BuildParameters.WebHost }, - { "LinkRoot", BuildParameters.WebLinkRoot }, - { "BaseEditUrl", BuildParameters.WebBaseEditUrl }, - { "Title", BuildParameters.Title }, - { "IncludeGlobalNamespace", false } - }; - - if (BuildParameters.ShouldDocumentSourceFiles) - { - settings.Add("SourceFiles", BuildParameters.WyamSourceFiles); - } - - Wyam(new WyamSettings - { - Recipe = BuildParameters.WyamRecipe, - Theme = BuildParameters.WyamTheme, - OutputPath = MakeAbsolute(BuildParameters.Paths.Directories.PublishedDocumentation), - RootPath = BuildParameters.WyamRootDirectoryPath, - Preview = true, - Watch = true, - ConfigurationFile = BuildParameters.WyamConfigurationFile, - PreviewVirtualDirectory = BuildParameters.WebLinkRoot, - Settings = settings - }); - }) -); - -BuildParameters.Tasks.ForcePublishDocumentationTask = Task("Force-Publish-Documentation") - .IsDependentOn("Clean-Documentation") - .WithCriteria(() => DirectoryExists(BuildParameters.WyamRootDirectoryPath), "Wyam documentation directory is missing") - .Does(() => RequireTool(BuildParameters.IsDotNetBuild ? ToolSettings.WyamGlobalTool : ToolSettings.WyamTool, () => { - var settings = new Dictionary - { - { "Host", BuildParameters.WebHost }, - { "LinkRoot", BuildParameters.WebLinkRoot }, - { "BaseEditUrl", BuildParameters.WebBaseEditUrl }, - { "Title", BuildParameters.Title }, - { "IncludeGlobalNamespace", false } - }; - - if (BuildParameters.ShouldDocumentSourceFiles) - { - settings.Add("SourceFiles", BuildParameters.WyamSourceFiles); - } - - Wyam(new WyamSettings - { - Recipe = BuildParameters.WyamRecipe, - Theme = BuildParameters.WyamTheme, - OutputPath = MakeAbsolute(BuildParameters.Paths.Directories.PublishedDocumentation), - RootPath = BuildParameters.WyamRootDirectoryPath, - ConfigurationFile = BuildParameters.WyamConfigurationFile, - PreviewVirtualDirectory = BuildParameters.WebLinkRoot, - Settings = settings - }); - - PublishDocumentation(); - }) -); - -public void PublishDocumentation() -{ - RequireTool(BuildParameters.IsDotNetBuild ? ToolSettings.KuduSyncGlobalTool : ToolSettings.KuduSyncTool, () => { - if (BuildParameters.CanUseWyam) - { - var sourceCommit = GitLogTip("./"); - - var publishFolder = BuildParameters.WyamPublishDirectoryPath.Combine(DateTime.Now.ToString("yyyyMMdd_HHmmss")); - Information("Publishing Folder: {0}", publishFolder); - Information("Getting publish branch..."); - GitClone(BuildParameters.Wyam.DeployRemote, publishFolder, new GitCloneSettings{ BranchName = BuildParameters.Wyam.DeployBranch }); - - Information("Sync output files..."); - Kudu.Sync(BuildParameters.Paths.Directories.PublishedDocumentation, publishFolder, new KuduSyncSettings { - ArgumentCustomization = args=>args.Append("--ignore").AppendQuoted(".git;CNAME") - }); - - if (GitHasUncommitedChanges(publishFolder)) - { - Information("Stage all changes..."); - GitAddAll(publishFolder); - - if (GitHasStagedChanges(publishFolder)) - { - Information("Commit all changes..."); - GitCommit( - publishFolder, - sourceCommit.Committer.Name, - sourceCommit.Committer.Email, - string.Format("Continuous Integration Publish: {0}\r\n{1}", sourceCommit.Sha, sourceCommit.Message) - ); - - Information("Pushing all changes..."); - GitPush(publishFolder, BuildParameters.Wyam.AccessToken, "x-oauth-basic", BuildParameters.Wyam.DeployBranch); - } - } - } - else - { - Warning("Unable to publish documentation, as not all Wyam Configuration is present"); - } - }); -} diff --git a/config.wyam b/config.wyam deleted file mode 100644 index ec662934..00000000 --- a/config.wyam +++ /dev/null @@ -1 +0,0 @@ -System.Globalization.CultureInfo.DefaultThreadCurrentCulture = System.Globalization.CultureInfo.CreateSpecificCulture("en-GB"); diff --git a/config.wyam.dll b/config.wyam.dll deleted file mode 100644 index 6be88d0b..00000000 Binary files a/config.wyam.dll and /dev/null differ diff --git a/config.wyam.hash b/config.wyam.hash deleted file mode 100644 index 47160929..00000000 --- a/config.wyam.hash +++ /dev/null @@ -1 +0,0 @@ -F811FD69EF12101D64C993648BA14C1432B680E7EDCC76CF4D433500022F195BB0590335AB2546CFF3ECBCF441AA6686DF48369814BC6697FC2F82C80BFD5E25 \ No newline at end of file diff --git a/config.wyam.packages.xml b/config.wyam.packages.xml deleted file mode 100644 index 4d1932d8..00000000 --- a/config.wyam.packages.xml +++ /dev/null @@ -1,211 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/input/docs/fundamentals/environment-variables.md b/docs/input/docs/fundamentals/environment-variables.md index 1d43cf35..86699be3 100644 --- a/docs/input/docs/fundamentals/environment-variables.md +++ b/docs/input/docs/fundamentals/environment-variables.md @@ -204,37 +204,3 @@ In addition to these environment variables being present, and correct, there are ::: ### TRANSIFEX_API_TOKEN - -## Wyam - -During the execution of Cake.Recipe, a documentation site can also be generated (both for project source code files, and documentation files), using the Wyam Tool. Further information about [publishing documentation](../usage/publishing-documentation) can be found in the docs. - -:::{.alert .alert-info} -**NOTE:** - -In addition to these environment variables being present, and correct, there are a number of parameters that also need to be set correctly: - -* [wyamRootDirectoryPath](./set-parameters#wyamRootDirectoryPath) -* [wyamPublishDirectoryPath](./set-parameters#wyamPublishDirectoryPath) -* [wyamPublishDirectoryPath](./set-parameters#wyamPublishDirectoryPath) -* [wyamRecipe](./set-parameters#wyamRecipe) -* [wyamTheme](./set-parameters#wyamTheme) -* [wyamSourceFiles](./set-parameters#wyamSourceFiles) -* [webHost](./set-parameters#webHost) -* [webLinkRoot](./set-parameters#webLinkRoot) -* [webBaseEditUrl](./set-parameters#webBaseEditUrl) -* [shouldGenerateDocumentation](./set-parameters#shouldGenerateDocumentation) -* [shouldDocumentSourceFiles](./set-parameters#shouldDocumentSourceFiles) -::: - -### WYAM_ACCESS_TOKEN - -Access token to use to publish the Wyam documentation. - -### WYAM_DEPLOY_REMOTE - -URI of the remote repository where the Wyam documentation is published to. - -### WYAM_DEPLOY_BRANCH - -Branch into which the Wyam documentation should be published. diff --git a/docs/input/docs/fundamentals/print-parameters.md b/docs/input/docs/fundamentals/print-parameters.md index 3f958160..583e1352 100644 --- a/docs/input/docs/fundamentals/print-parameters.md +++ b/docs/input/docs/fundamentals/print-parameters.md @@ -47,16 +47,6 @@ CanPushTranslations: False PrepareLocalRelease: False BuildAgentOperatingSystem: Windows ForceContinuousIntegration: False -WyamRootDirectoryPath: C:/projects/gitreleasemanager/docs -WyamPublishDirectoryPath: C:/projects/gitreleasemanager/BuildArtifacts/temp/_PublishedDocumentation -WyamConfigurationFile: C:/projects/gitreleasemanager/config.wyam -WyamRecipe: Docs -WyamTheme: Samson -Wyam Deploy Branch: gh-pages -Wyam Deploy Remote: https://github.com/GitTools/GitReleaseManager -WebHost: GitTools.github.io -WebLinkRoot: GitReleaseManager -WebBaseEditUrl: https://github.com/GitTools/GitReleaseManager/tree/develop/docs/input/ NuSpecFilePath: C:/projects/gitreleasemanager/Cake.Recipe/Cake.Recipe.nuspec NugetConfig: C:/projects/gitreleasemanager/NuGet.Config (False) NuGetSources: https://api.nuget.org/v3/index.json, https://www.myget.org/F/cake-contrib/api/v3/index.json diff --git a/docs/input/docs/fundamentals/set-parameters.md b/docs/input/docs/fundamentals/set-parameters.md index 323dc1b2..ed37ee63 100644 --- a/docs/input/docs/fundamentals/set-parameters.md +++ b/docs/input/docs/fundamentals/set-parameters.md @@ -24,9 +24,7 @@ BuildParameters.SetParameters(context: Context, shouldPublishChocolatey: false, shouldPublishNuGet: false, shouldPublishGitHub: false, - shouldCalculateVersion: true, - webLinkRoot: "ChocolateyGUI", - webBaseEditUrl: "https://github.com/chocolatey/ChocolateyGUI/tree/develop/docs/input/"); + shouldCalculateVersion: true); ``` ## Required Parameters @@ -350,7 +348,7 @@ true ### shouldGenerateDocumentation -This is used as a final control variable for whether or not Wyam should be executed to generate documentation for the project. +This is used as a final control variable for whether or not to generate documentation for the project. Type: `bool` @@ -362,7 +360,7 @@ true ### shouldDocumentSourceFiles -This is used as a final control variable for whether or not Wyam should be executed against the source files for the project to generate additional documentation. +This is used as a final control variable for whether or not the source files for the project should be used to generate additional documentation. Type: `bool` @@ -541,113 +539,6 @@ Default Value: Version {0} of the {1} Addin has just been released, this will be available here https://www.nuget.org/packages/{1}, once package indexing is complete." ``` -### wyamRootDirectoryPath - -This is the directory that stores the documentation files that will be passed to the Wyam tool. - -Type: `DirectoryPath` - -Default Value: - -```csharp -context.MakeAbsolute(context.Directory("docs")); -``` - -### wyamPublishDirectoryPath - -This is the directory that will be passed to Wyam for where the output documentation should be published to. - -Type: `DirectoryPath` - -Default Value: - -```csharp -context.MakeAbsolute(context.Directory("BuildArtifacts/temp/_PublishedDocumentation")); -``` - -### wyamConfigurationFile - -This is the location of the configuration file that will be passed to the Wyam tool. - -Type: `FilePath` - -Default Value: - -```csharp -context.MakeAbsolute((FilePath)"config.wyam") -``` - -### wyamRecipe - -This is the name of the recipe that should be used by the Wyam tool. - -Type: `string` - -Default Value: - -```csharp -Docs -``` - -### wyamTheme - -This is the name of the them that should be used by the Wyam tool. -Type: `string` - -Default Value: - -```csharp -Samson -``` - -### wyamSourceFiles - -This is the location of all the source files that should be used to generate documentation by the Wyam tool. - -Type: `string` - -Default Value: - -```csharp -"../../" + SourceDirectoryPath.FullPath + "/**/{!bin,!obj,!packages,!*.Tests,}/**/*.cs"; -``` - -### webHost - -The root URL for generating documentation via the Wyam tool. - -Type: `string` - -Default Value: - -```csharp -string.Format("{0}.github.io", repositoryOwner) -``` - -### webLinkRoot - -A value which is concatenated to the WebLinkRoot when generating documentation via the Wyam tool. - -Type: `string` - -Default Value: - -```csharp -RepositoryName -``` - -### webBaseEditUrl - -When generating documentation via Wyam, this value is used to create a clickable link for editing the documentation when published. - -Type: `string` - -Default Value: - -```csharp -string.Format("https://github.com/{0}/{1}/tree/{2}/docs/input/", repositoryOwner, title, developBranchName) -``` - ### nuspecFilePath When running the top level RunNuGet task, this parameter value is used to locate the nuspec file which should be packed. diff --git a/docs/input/docs/fundamentals/set-variable-names.md b/docs/input/docs/fundamentals/set-variable-names.md index 9f6e869b..ecf125b7 100644 --- a/docs/input/docs/fundamentals/set-variable-names.md +++ b/docs/input/docs/fundamentals/set-variable-names.md @@ -110,15 +110,3 @@ Default value: `MICROSOFTTEAMS_WEBHOOKURL` ### transifexApiTokenVariable Default value: `TRANSIFEX_API_TOKEN` - -### wyamAccessTokenVariable - -Default value: `WYAM_ACCESS_TOKEN` - -### wyamDeployRemoteVariable - -Default value: `WYAM_DEPLOY_REMOTE` - -### wyamDeployBranchVariable - -Default value: `WYAM_DEPLOY_BRANCH` diff --git a/docs/input/docs/overview/features.md b/docs/input/docs/overview/features.md index 36b9ede4..e100f6fe 100644 --- a/docs/input/docs/overview/features.md +++ b/docs/input/docs/overview/features.md @@ -28,8 +28,6 @@ Cake.Recipe combines the usage of a number of different tools to provide its fea * GiReleaseManager * GitVersion * ReSharperTools -* KuduSync -* Wyam * Xunit * NUnit * OpenCover diff --git a/docs/input/docs/usage/getting-started-with-cake-recipe.md b/docs/input/docs/usage/getting-started-with-cake-recipe.md index 321c0975..fc4561e8 100644 --- a/docs/input/docs/usage/getting-started-with-cake-recipe.md +++ b/docs/input/docs/usage/getting-started-with-cake-recipe.md @@ -51,4 +51,4 @@ Cake.Recipe will not suit everyone out of the box, but it has been designed in a # 6. Next steps -Try configuring the additional tasks by including configuration files for the tools that have been added, i.e. AppVeyor, GitVersion, Wyam, etc, and be sure to look around the [Cake.Recipe](../) site for more information. +Try configuring the additional tasks by including configuration files for the tools that have been added, i.e. AppVeyor, GitVersion, etc, and be sure to look around the [Cake.Recipe](../) site for more information. diff --git a/docs/input/docs/usage/previewing-documentation.md b/docs/input/docs/usage/previewing-documentation.md index ee0a9cfd..76642e9e 100644 --- a/docs/input/docs/usage/previewing-documentation.md +++ b/docs/input/docs/usage/previewing-documentation.md @@ -9,7 +9,7 @@ This document describes how to preview the documentation in a local webserver us 1. Run: - On Windows: `.\build.ps1 --target=preview` - On MacOS/Linux: `./build.sh --target=preview`. -2. Open your browser at `http:\\localhost:5080\` +2. Open your browser at `http:\\localhost:5080\` :::{.alert .alert-info} The scripts supports watching for changes and automatically rebuilds the documentation without requiring to restart the build task. diff --git a/docs/input/docs/usage/publishing-documentation.md b/docs/input/docs/usage/publishing-documentation.md index 6dfa52dd..005cae76 100644 --- a/docs/input/docs/usage/publishing-documentation.md +++ b/docs/input/docs/usage/publishing-documentation.md @@ -6,15 +6,6 @@ Description: How to publish documentation with Cake.Recipe This document describes how to publish the documentation to the configured branch using the `Cake.Recipe` script. -:::{.alert .alert-info} -Please note that for every change done in the `BuildParameters.WyamPublishDirectoryPath` automatically triggers a deployment as part of the build. -Manually publishing the documentation is only required if there are changes in the source code (Method signatures, namespaces, XML comments, ...). -::: - -1. Make sure that you have the following environment variables set in your local development environment: - - [WYAM_ACCESS_TOKEN](../fundamentals/environment-variables#wyam_access_token) - - [WYAM_DEPLOY_BRANCH](../fundamentals/environment-variables#wyam_deploy_branch) - - [WYAM_DEPLOY_REMOTE](../fundamentals/environment-variables#wyam_deploy_remote) -2. Run: +1. Run: - On Windows: `.\build.ps1 --target=publishdocs` - On MacOS/Linux: `./build.sh --target=publishdocs` diff --git a/recipe.cake b/recipe.cake index b34b0609..a1dc8191 100644 --- a/recipe.cake +++ b/recipe.cake @@ -23,8 +23,7 @@ BuildParameters.SetParameters(context: Context, shouldRunCoveralls: false, shouldRunCodecov: false, shouldRunDotNetPack: true, - twitterMessage: standardNotificationMessage, - shouldGenerateDocumentation: false); + twitterMessage: standardNotificationMessage); BuildParameters.PrintParameters(Context);