Skip to content

Commit a13921c

Browse files
committed
Updated build support to use a distinct branch for docs
* This is not only consistent with how things hve always worked but also prevents the need to build docs locally - Also eliminate the need to "trust" every contributor to always do that. * Let's be honest and admit that's not going to happen a lot of times!. An automated process of building the docs and VERIFYING they build as part of a PR is a much better answer. * Forced line endings to auto in .gitattributes to account for users that might not have it set globally. * Removed use of obsolete packages and generally made the packages.props more consistent with other libraries for easier comparison.
1 parent 5ba9059 commit a13921c

File tree

236 files changed

+33
-11776
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

236 files changed

+33
-11776
lines changed

.gitattributes

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Set the default behavior, in case people don't have core.autocrlf set in global settings
2+
* text=auto

.github/workflows/ci-build.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
name: CI Build
22

3-
on: [push]
3+
on:
4+
push:
5+
branches:
6+
- 'master'
47

58
jobs:
69
build:
@@ -15,4 +18,4 @@ jobs:
1518
global-json-file: global.json
1619
- name: Build with PowerShell
1720
shell: pwsh
18-
run: .\Build-All.ps1 -Configuration Release -ForceClean
21+
run: .\Build-All.ps1 -Configuration Release -ForceClean -BuildMode Source

Build-Docs.ps1

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@ function Get-FullBuildNumber
5757
return "$($versionInfo['FullBuildNumber'])"
5858
}
5959

60-
6160
$docFXToolVersion = '2.78.3'
6261

6362
$InformationPreference = 'Continue'
@@ -80,6 +79,28 @@ try
8079
$docsOutputPath = $buildInfo['DocsOutputPath']
8180
Write-Verbose "Docs OutputPath: $docsOutputPath"
8281

82+
# Clone docs output location so it is available as a destination for the Generated docs content
83+
# and the versioned docs links can function correctly for locally generated docs
84+
if(!$NoClone -and !(Test-Path (Join-Path $docsOutputPath '.git') -PathType Container))
85+
{
86+
if(Test-Path -PathType Container $docsOutputPath)
87+
{
88+
Write-Information "Cleaning $docsOutputPath"
89+
Remove-Item -Path $docsOutputPath -Recurse -Force
90+
}
91+
92+
Write-Information "Cloning Docs repository"
93+
Invoke-Git clone https://github.com/UbiquityDotNET/Llvm.NET.git -b gh-pages $docsOutputPath -q
94+
}
95+
96+
# remove all contents from 'current' docs to ensure clean generated docs for this release
97+
$currentVersionDocsPath = Join-Path $docsOutputPath 'current'
98+
if(Test-Path -PathType Container $currentVersionDocsPath)
99+
{
100+
Write-Information 'Cleaning current version folder'
101+
Remove-Item -Path $currentVersionDocsPath -Recurse -Force
102+
}
103+
83104
$fullBuildNumber = Get-FullBuildNumber
84105

85106
Push-Location './src/docs'

Packages.props

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,18 @@
77
<GlobalPackageReference Include="CSemVer.Build.Tasks" Version="2.0.5" />
88
<GlobalPackageReference Include="Microsoft.CodeAnalysis.NetAnalyzers" Version="9.0.0" Condition="'$(NoCommonAnalyzers)' !=' true'" />
99
<GlobalPackageReference Include="IDisposableAnalyzers" Version="4.0.8" Condition="'$(NoCommonAnalyzers)' !=' true'" />
10-
<!--This analyzer is officially archived on GitHub and not actively maintained; and behind the times on language support -->
11-
<!--<GlobalPackageReference Include="RefactoringEssentials" Version="5.6.0" Condition="'$(NoCommonAnalyzers)' != 'true'" />-->
1210
<GlobalPackageReference Include="StyleCop.Analyzers" Version="1.1.118" Condition="'$(NoCommonAnalyzers)' != 'true'" />
1311
</ItemGroup>
1412

1513
<!--
1614
Package versions made consistent across all packages referenced in this repository
1715
-->
1816
<ItemGroup>
17+
<PackageReference Update="Sprache" Version="2.3.1" />
18+
19+
<!-- Tests all use the same framework versions -->
1920
<PackageReference Update="Microsoft.NET.Test.Sdk" Version="17.13.0" />
20-
<PackageReference Update="MSTest.TestFramework" Version="3.8.3" />
2121
<PackageReference Update="MSTest.TestAdapter" Version="3.8.3" />
22-
<PackageReference Update="Sprache" Version="2.3.1" />
22+
<PackageReference Update="MSTest.TestFramework" Version="3.8.3" />
2323
</ItemGroup>
2424
</Project>

docs/.nojekyll

Whitespace-only changes.

docs/api/Ubiquity.CommandlineParsing.CommandLineBinderExtensions.html

Lines changed: 0 additions & 223 deletions
This file was deleted.

0 commit comments

Comments
 (0)