Skip to content

Commit 171da16

Browse files
committed
update favicon.ico, updated the API docs source files pattern
1 parent 03dec0c commit 171da16

File tree

4 files changed

+17
-24
lines changed

4 files changed

+17
-24
lines changed

build.ps1

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,7 @@ Remove-PathVariable "$InstallPath"
168168
Add-PathVariable "$InstallPath"
169169
$env:DOTNET_ROOT=$InstallPath
170170

171+
$env:DOTNET_ROLL_FORWARD="major"
171172
$env:DOTNET_SKIP_FIRST_TIME_EXPERIENCE=1
172173
$env:DOTNET_CLI_TELEMETRY_OPTOUT=1
173174
$env:DOTNET_NOLOGO=$true

build/docs.cake

Lines changed: 7 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ Task("Preview-Documentation")
88
.WithCriteria(() => DirectoryExists(MakeAbsolute(Directory("docs"))), "Wyam documentation directory is missing")
99
.Does<BuildParameters>((parameters) =>
1010
{
11+
var additionalSettings = parameters.WyamAdditionalSettings;
12+
additionalSettings.Add("Host", "gittools.github.io");
1113
Wyam(new WyamSettings
1214
{
1315
Recipe = "Docs",
@@ -17,14 +19,7 @@ Task("Preview-Documentation")
1719
Preview = true,
1820
Watch = true,
1921
ConfigurationFile = MakeAbsolute((FilePath)"config.wyam"),
20-
Settings = new Dictionary<string, object>
21-
{
22-
{ "Host", "gittools.github.io" },
23-
{ "BaseEditUrl", "https://github.com/gittools/GitVersion/tree/master/docs/input/" },
24-
{ "SourceFiles", MakeAbsolute(parameters.Paths.Directories.Source) + "/**/{!bin,!obj,!packages,!*.Tests,}/**/*.cs" },
25-
{ "Title", "GitVersion" },
26-
{ "IncludeGlobalNamespace", false }
27-
}
22+
Settings = additionalSettings
2823
});
2924
});
3025

@@ -40,13 +35,7 @@ Task("Force-Publish-Documentation")
4035
OutputPath = MakeAbsolute(Directory("artifacts/Documentation")),
4136
RootPath = MakeAbsolute(Directory("docs")),
4237
ConfigurationFile = MakeAbsolute((FilePath)"config.wyam"),
43-
Settings = new Dictionary<string, object>
44-
{
45-
{ "BaseEditUrl", "https://github.com/gittools/GitVersion/tree/master/docs/input/" },
46-
{ "SourceFiles", MakeAbsolute(parameters.Paths.Directories.Source) + "/**/{!bin,!obj,!packages,!*.Tests,}/**/*.cs" },
47-
{ "Title", "GitVersion" },
48-
{ "IncludeGlobalNamespace", false }
49-
}
38+
Settings = parameters.WyamAdditionalSettings
5039
});
5140

5241
PublishDocumentation(parameters);
@@ -77,8 +66,8 @@ Task("Publish-Documentation-Internal")
7766
file.Path.Contains(string.Format("{0}{1}", wyamDocsFolderDirectoryName, forwardSlash)) ||
7867
file.Path.Contains("config.wyam"))
7968
{
80-
docFileChanged = true;
81-
break;
69+
docFileChanged = true;
70+
break;
8271
}
8372
}
8473

@@ -93,13 +82,7 @@ Task("Publish-Documentation-Internal")
9382
OutputPath = MakeAbsolute(Directory("artifacts/Documentation")),
9483
RootPath = MakeAbsolute(Directory("docs")),
9584
ConfigurationFile = MakeAbsolute((FilePath)"config.wyam"),
96-
Settings = new Dictionary<string, object>
97-
{
98-
{ "BaseEditUrl", "https://github.com/gittools/GitVersion/tree/master/docs/input/" },
99-
{ "SourceFiles", MakeAbsolute(parameters.Paths.Directories.Source) + "/**/{!bin,!obj,!packages,!*.Tests,}/**/*.cs" },
100-
{ "Title", "GitVersion" },
101-
{ "IncludeGlobalNamespace", false }
102-
}
85+
Settings = parameters.WyamAdditionalSettings
10386
});
10487

10588
PublishDocumentation(parameters);

build/utils/parameters.cake

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ public class BuildParameters
5656
public DockerImages Docker { get; private set; }
5757
public Dictionary<string, DirectoryPath> PackagesBuildMap { get; private set; }
5858
public Dictionary<PlatformFamily, string[]> NativeRuntimes { get; private set; }
59+
public Dictionary<string, object> WyamAdditionalSettings { get; private set; }
5960

6061
public bool IsStableRelease() => !IsLocalBuild && IsMainRepo && IsMainBranch && !IsPullRequest && IsTagged;
6162
public bool IsPreRelease() => !IsLocalBuild && IsMainRepo && IsMainBranch && !IsPullRequest && !IsTagged;
@@ -146,6 +147,14 @@ public class BuildParameters
146147
[PlatformFamily.OSX] = new[] { "osx-x64" },
147148
};
148149

150+
WyamAdditionalSettings = new Dictionary<string, object>
151+
{
152+
{ "BaseEditUrl", "https://github.com/gittools/GitVersion/tree/master/docs/input/" },
153+
{ "SourceFiles", context.MakeAbsolute(Paths.Directories.Source) + "/**/{!bin,!obj,!packages,!*.Tests,!GitTools.*,}/**/*.cs" },
154+
{ "Title", "GitVersion" },
155+
{ "IncludeGlobalNamespace", false }
156+
};
157+
149158
Credentials = BuildCredentials.GetCredentials(context);
150159
SetMSBuildSettingsVersion(MSBuildSettings, Version);
151160
}

docs/input/assets/img/favicon.ico

0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)