Netcore: Update code docs generation (#9885)
* Updated the code docs to work with new assemblies and namespaces+added conditional build to default pipeline * updated script that generate docs to use .NET 5 * Increased timeout of docs generation + changed to 5.x instead of 5.0.x Fixed wrong namespace, that would be we not have docs for it. * Fixed names in toc, so they are not that long and changed ordering * try custom hack https://github.com/dotnet/docfx/issues/1254#issuecomment-294080535 * revert nonworking hack - Divide prep steps into two. * Changed ordering * Try to generate docs without the build.ps1 script * Try to generate docs without the build.ps1 script * Try to generate docs without the build.ps1 script * Try to remove the examine one, to test if that is the reason it fails on azure pipeline * Try to remove the sqlce one, to test if that is the reason it fails on azure pipeline * Reintroduce Examine and SqlCE docs, as these was not the reason it will not work on azure pipeline. * Test if azure wanna build the docs without explicit version * Fixed two malformed xml docs * hardcode version of docfx, to hopefully let it pass on azure pipeline * hardcode version of docfx, to hopefully let it pass on azure pipeline * Restructure azure pipeline yaml to have stages as areas instead of OS * Restructure azure pipeline yaml to have stages as areas instead of OS * yml restructure * yml restructure * yml restructure * Not hardcoding docfx as the old versions also fail on azure * Fixed Badly formed XML comments * moved condition from job to stage * split build and metadata * indentation * removed wrong char * Try to add more loging on azure pipeline * include less * include less projects * add one more project * More azure pipeline test * indentation * All except infrastructure * publish tasks * Fix link on logo * Extensions also included * Less links * re-introduced infrastructure to the list of projects for generate docfx for. * Add filter * Remove single warning for xmldocs * more logging? * skip some things from the metadata * test using other image * Test if exclude filter works * Test with more explict filters, allowing some docs from Infrastructure * binary search for the file that is the issue * binary search for the file that is the issue * binary search for the file that is the issue * Exclude more folders * Exclude more folders and files * Only exclude files in root of namespace? * more filter trials * more filter trials * add 2 nested folders * all cs files? * Remove test projects * Toc * Update build/azure-pipelines.yml * move display name element * Update build/azure-pipelines.yml Co-authored-by: Mole <nikolajlauridsen@protonmail.ch> Co-authored-by: Mole <nikolajlauridsen@protonmail.ch>
This commit is contained in:
Bjarke Berg
@@ -1,277 +1,317 @@
|
||||
#############################################################################
|
||||
## ASP.NET Core ##
|
||||
## Build and test ASP.NET Core projects targeting .NET Core. ##
|
||||
## Runs tests, creates NuGet packages: ##
|
||||
## https://docs.microsoft.com/azure/devops/pipelines/languages/dotnet-core ##
|
||||
#############################################################################
|
||||
|
||||
# Variables & their default values
|
||||
variables:
|
||||
buildConfiguration: 'Release'
|
||||
SA_PASSWORD: UmbracoIntegration123!
|
||||
|
||||
buildConfiguration: Release
|
||||
SA_PASSWORD: UmbracoIntegration123!
|
||||
resources:
|
||||
containers:
|
||||
- container: mssql
|
||||
image: mcr.microsoft.com/mssql/server:2017-latest
|
||||
env:
|
||||
ACCEPT_EULA: Y
|
||||
SA_PASSWORD: $(SA_PASSWORD)
|
||||
MSSQL_PID: Developer
|
||||
ports:
|
||||
- 1433:1433
|
||||
options: --name mssql
|
||||
|
||||
containers:
|
||||
- container: mssql
|
||||
image: 'mcr.microsoft.com/mssql/server:2017-latest'
|
||||
env:
|
||||
ACCEPT_EULA: 'Y'
|
||||
SA_PASSWORD: $(SA_PASSWORD)
|
||||
MSSQL_PID: Developer
|
||||
ports:
|
||||
- '1433:1433'
|
||||
options: '--name mssql'
|
||||
stages:
|
||||
- stage: Linux
|
||||
dependsOn: [] # this removes the implicit dependency on previous stage and causes this to run in parallel
|
||||
jobs:
|
||||
- stage: Unit_Tests
|
||||
displayName: Unit Tests
|
||||
dependsOn: []
|
||||
jobs:
|
||||
- job: Linux_Unit_Tests
|
||||
displayName: Linux
|
||||
pool:
|
||||
vmImage: ubuntu-latest
|
||||
steps:
|
||||
- task: UseDotNet@2
|
||||
displayName: Use .Net Core sdk 5.x
|
||||
inputs:
|
||||
version: 5.x
|
||||
- task: DotNetCoreCLI@2
|
||||
displayName: dotnet test
|
||||
inputs:
|
||||
command: test
|
||||
projects: '**/*.Tests.UnitTests.csproj'
|
||||
- job: MacOS_Unit_Tests
|
||||
displayName: Mac OS
|
||||
pool:
|
||||
vmImage: macOS-latest
|
||||
steps:
|
||||
- task: UseDotNet@2
|
||||
displayName: Use .Net Core sdk 5.x
|
||||
inputs:
|
||||
version: 5.x
|
||||
- task: DotNetCoreCLI@2
|
||||
displayName: dotnet test
|
||||
inputs:
|
||||
command: test
|
||||
projects: '**/*.Tests.UnitTests.csproj'
|
||||
- job: Windows_Unit_Tests
|
||||
displayName: Windows
|
||||
pool:
|
||||
vmImage: windows-latest
|
||||
steps:
|
||||
- task: UseDotNet@2
|
||||
displayName: Use .Net Core sdk 5.x
|
||||
inputs:
|
||||
version: 5.x
|
||||
- task: DotNetCoreCLI@2
|
||||
displayName: dotnet test
|
||||
inputs:
|
||||
command: test
|
||||
projects: '**/*.Tests.UnitTests.csproj'
|
||||
- stage: Integration_Tests
|
||||
displayName: Integration Tests
|
||||
dependsOn: []
|
||||
jobs:
|
||||
- job: Linux_Integration_Tests
|
||||
services:
|
||||
mssql: mssql
|
||||
timeoutInMinutes: 120
|
||||
displayName: Linux
|
||||
pool:
|
||||
vmImage: ubuntu-latest
|
||||
steps:
|
||||
- task: UseDotNet@2
|
||||
displayName: Use .Net Core sdk 5.x
|
||||
inputs:
|
||||
version: 5.x
|
||||
- task: DotNetCoreCLI@2
|
||||
displayName: dotnet test
|
||||
inputs:
|
||||
command: test
|
||||
projects: '**/Umbraco.Tests.Integration.csproj'
|
||||
env:
|
||||
UmbracoIntegrationTestConnectionString: 'Server=localhost,1433;User Id=sa;Password=$(SA_PASSWORD);'
|
||||
- job: Windows_Integration_Tests
|
||||
timeoutInMinutes: 120
|
||||
displayName: Windows
|
||||
pool:
|
||||
vmImage: windows-latest
|
||||
steps:
|
||||
- task: UseDotNet@2
|
||||
displayName: Use .Net Core sdk 5.x
|
||||
inputs:
|
||||
version: 5.x
|
||||
- powershell: sqllocaldb start mssqllocaldb
|
||||
displayName: Start MSSQL LocalDb
|
||||
- task: DotNetCoreCLI@2
|
||||
displayName: dotnet test
|
||||
inputs:
|
||||
command: test
|
||||
projects: '**\Umbraco.Tests.Integration.csproj'
|
||||
- stage: Artifacts
|
||||
dependsOn: []
|
||||
jobs:
|
||||
- job: Build_Artifacts
|
||||
displayName: Build Artifacts
|
||||
pool:
|
||||
vmImage: windows-latest
|
||||
steps:
|
||||
- task: UseDotNet@2
|
||||
displayName: Use .Net Core sdk 5.x
|
||||
inputs:
|
||||
version: 5.x
|
||||
- task: NuGetToolInstaller@1
|
||||
displayName: Use NuGet Latest
|
||||
- task: NuGetCommand@2
|
||||
displayName: Restore NuGet Packages
|
||||
inputs:
|
||||
restoreSolution: '*\src\umbraco.sln'
|
||||
feedsToUse: config
|
||||
- task: PowerShell@1
|
||||
displayName: Update Version
|
||||
condition: 'eq(variables[''Umbraco.IsReleaseBuild''], ''false'')'
|
||||
inputs:
|
||||
scriptType: inlineScript
|
||||
inlineScript: >
|
||||
Write-Host "Working folder: $pwd"
|
||||
|
||||
- job: Unit_Tests
|
||||
displayName: 'Unit Tests'
|
||||
pool:
|
||||
vmImage: 'ubuntu-latest'
|
||||
steps:
|
||||
$ubuild = build/build.ps1 -get -continue
|
||||
|
||||
- task: UseDotNet@2
|
||||
displayName: 'Use .Net Core sdk 5.0.x'
|
||||
inputs:
|
||||
version: 5.0.x
|
||||
|
||||
- task: DotNetCoreCLI@2
|
||||
displayName: 'dotnet test'
|
||||
inputs:
|
||||
command: test
|
||||
projects: '**/*.Tests.UnitTests.csproj'
|
||||
$version = $ubuild.GetUmbracoVersion()
|
||||
|
||||
- job: Integration_Tests
|
||||
services:
|
||||
mssql: mssql
|
||||
timeoutInMinutes: 120
|
||||
displayName: 'Integration Tests'
|
||||
pool:
|
||||
vmImage: 'ubuntu-latest'
|
||||
steps:
|
||||
if ($version.Comment -ne "")
|
||||
{
|
||||
# 8.0.0-beta.33.1234
|
||||
$continuous = "$($version.Semver).$(Build.BuildNumber)"
|
||||
}
|
||||
else
|
||||
{
|
||||
# 8.0.0-alpha.1234
|
||||
$continuous = "$($version.Release)-alpha.$(Build.BuildNumber)"
|
||||
}
|
||||
$ubuild.SetUmbracoVersion($continuous)
|
||||
|
||||
- task: UseDotNet@2
|
||||
displayName: 'Use .Net Core sdk 5.0.x'
|
||||
inputs:
|
||||
version: 5.0.x
|
||||
|
||||
- task: DotNetCoreCLI@2
|
||||
displayName: 'dotnet test'
|
||||
inputs:
|
||||
command: test
|
||||
projects: '**/Umbraco.Tests.Integration.csproj'
|
||||
env:
|
||||
UmbracoIntegrationTestConnectionString: 'Server=localhost,1433;User Id=sa;Password=$(SA_PASSWORD);'
|
||||
#Update the version in template also
|
||||
|
||||
- stage: MacOS
|
||||
dependsOn: [] # this removes the implicit dependency on previous stage and causes this to run in parallel
|
||||
jobs:
|
||||
$templatePath =
|
||||
'build/templates/UmbracoSolution/.template.config/template.json'
|
||||
|
||||
- job: Unit_Tests
|
||||
displayName: 'Unit Tests'
|
||||
pool:
|
||||
vmImage: 'macOS-latest'
|
||||
steps:
|
||||
$a = Get-Content $templatePath -raw | ConvertFrom-Json
|
||||
|
||||
- task: UseDotNet@2
|
||||
displayName: 'Use .Net Core sdk 5.0.x'
|
||||
inputs:
|
||||
version: 5.0.x
|
||||
$a.symbols.version.defaultValue = $continuous
|
||||
|
||||
- task: DotNetCoreCLI@2
|
||||
displayName: 'dotnet test'
|
||||
inputs:
|
||||
command: test
|
||||
projects: '**/*.Tests.UnitTests.csproj'
|
||||
$a | ConvertTo-Json -depth 32| set-content $templatePath
|
||||
|
||||
- stage: Windows
|
||||
dependsOn: [] # this removes the implicit dependency on previous stage and causes this to run in parallel
|
||||
jobs:
|
||||
|
||||
- job: Unit_Tests
|
||||
displayName: 'Unit Tests'
|
||||
pool:
|
||||
vmImage: 'windows-latest'
|
||||
steps:
|
||||
Write-Host "Building: $continuous"
|
||||
- task: PowerShell@1
|
||||
displayName: Prepare Build
|
||||
inputs:
|
||||
scriptType: inlineScript
|
||||
inlineScript: |
|
||||
Write-Host "Working folder: $pwd"
|
||||
$ubuild = build\build.ps1 -get
|
||||
|
||||
- task: UseDotNet@2
|
||||
displayName: 'Use .Net Core sdk 5.0.x'
|
||||
inputs:
|
||||
version: 5.0.x
|
||||
$ubuild.PrepareBuild("vso")
|
||||
- task: NodeTool@0
|
||||
displayName: Use Node 11.x
|
||||
inputs:
|
||||
versionSpec: 11.x
|
||||
- task: Npm@1
|
||||
displayName: npm install
|
||||
inputs:
|
||||
workingDir: src\Umbraco.Web.UI.Client
|
||||
verbose: false
|
||||
- task: gulp@0
|
||||
displayName: gulp build
|
||||
inputs:
|
||||
gulpFile: src\Umbraco.Web.UI.Client\gulpfile.js
|
||||
targets: build
|
||||
workingDirectory: src\Umbraco.Web.UI.Client
|
||||
publishJUnitResults: true
|
||||
testResultsFiles: '**\TESTS-*.xml'
|
||||
- task: PowerShell@1
|
||||
displayName: Prepare Packages & Zip
|
||||
inputs:
|
||||
scriptType: inlineScript
|
||||
inlineScript: |
|
||||
Write-Host "Working folder: $pwd"
|
||||
$ubuild = build\build.ps1 -get -continue
|
||||
|
||||
- task: DotNetCoreCLI@2
|
||||
displayName: 'dotnet test'
|
||||
inputs:
|
||||
command: test
|
||||
projects: '**\*.Tests.UnitTests.csproj'
|
||||
$ubuild.CompileUmbraco()
|
||||
$ubuild.PreparePackages()
|
||||
$ubuild.PackageZip()
|
||||
- task: CopyFiles@2
|
||||
displayName: Copy Zip Files to Staging
|
||||
inputs:
|
||||
SourceFolder: build.out
|
||||
Contents: '*.zip'
|
||||
TargetFolder: $(build.artifactstagingdirectory)
|
||||
CleanTargetFolder: true
|
||||
- task: PublishBuildArtifacts@1
|
||||
displayName: Publish Zip Files
|
||||
inputs:
|
||||
PathtoPublish: $(build.artifactstagingdirectory)
|
||||
ArtifactName: zips
|
||||
- task: PowerShell@1
|
||||
displayName: Verify & Package NuGet
|
||||
inputs:
|
||||
scriptType: inlineScript
|
||||
inlineScript: |
|
||||
Write-Host "Working folder: $pwd"
|
||||
$ubuild = build\build.ps1 -get -continue
|
||||
|
||||
- job: Integration_Tests
|
||||
timeoutInMinutes: 120
|
||||
displayName: 'Integration Tests'
|
||||
pool:
|
||||
vmImage: 'windows-latest'
|
||||
steps:
|
||||
$ubuild.VerifyNuGet()
|
||||
$ubuild.PackageNuGet()
|
||||
- task: CopyFiles@2
|
||||
displayName: Copy NuPkg Files to Staging
|
||||
inputs:
|
||||
SourceFolder: build.out
|
||||
Contents: '*.nupkg'
|
||||
TargetFolder: $(build.artifactstagingdirectory)
|
||||
CleanTargetFolder: true
|
||||
- task: PublishBuildArtifacts@1
|
||||
displayName: Publish NuPkg Files
|
||||
inputs:
|
||||
PathtoPublish: $(build.artifactstagingdirectory)
|
||||
ArtifactName: nupkg
|
||||
- task: CopyFiles@2
|
||||
displayName: Copy Log Files to Staging
|
||||
inputs:
|
||||
SourceFolder: build.tmp
|
||||
Contents: '*.log'
|
||||
TargetFolder: $(build.artifactstagingdirectory)
|
||||
CleanTargetFolder: true
|
||||
condition: succeededOrFailed()
|
||||
- task: PublishBuildArtifacts@1
|
||||
displayName: Publish Log Files
|
||||
inputs:
|
||||
PathtoPublish: $(build.artifactstagingdirectory)
|
||||
ArtifactName: logs
|
||||
condition: succeededOrFailed()
|
||||
- stage: Artifacts_Docs
|
||||
displayName: 'Static Code Documentation'
|
||||
dependsOn: []
|
||||
condition: 'ne(variables[''Umbraco.IsReleaseBuild''], ''false'')'
|
||||
jobs:
|
||||
- job: Generate_Docs_CSharp
|
||||
timeoutInMinutes: 60
|
||||
displayName: Generate C# Docs
|
||||
pool:
|
||||
vmImage: windows-latest
|
||||
steps:
|
||||
- task: UseDotNet@2
|
||||
displayName: Use .Net Core sdk 5.x
|
||||
inputs:
|
||||
version: 5.x
|
||||
- task: PowerShell@2
|
||||
displayName: 'Prep build tool - C# Docs'
|
||||
inputs:
|
||||
targetType: inline
|
||||
script: |
|
||||
choco install docfx -y
|
||||
if ($lastexitcode -ne 0){
|
||||
throw ("Error installing DocFX")
|
||||
}
|
||||
docfx metadata --loglevel Verbose "$(Build.SourcesDirectory)\src\ApiDocs\docfx.json"
|
||||
if ($lastexitcode -ne 0){
|
||||
throw ("Error generating docs.")
|
||||
}
|
||||
docfx build --loglevel Verbose "$(Build.SourcesDirectory)\src\ApiDocs\docfx.json"
|
||||
if ($lastexitcode -ne 0){
|
||||
throw ("Error generating docs.")
|
||||
}
|
||||
errorActionPreference: continue
|
||||
workingDirectory: build
|
||||
- task: ArchiveFiles@2
|
||||
displayName: 'Zip C# Docs'
|
||||
inputs:
|
||||
rootFolderOrFile: $(Build.SourcesDirectory)\src\ApiDocs\_site
|
||||
includeRootFolder: false
|
||||
archiveType: zip
|
||||
archiveFile: $(Build.ArtifactStagingDirectory)\docs\csharp-docs.zip
|
||||
replaceExistingArchive: true
|
||||
- task: PublishPipelineArtifact@1
|
||||
displayName: Publish to artifacts - C# Docs
|
||||
inputs:
|
||||
targetPath: $(Build.ArtifactStagingDirectory)\docs\csharp-docs.zip
|
||||
artifact: docs-cs
|
||||
publishLocation: pipeline
|
||||
|
||||
- task: UseDotNet@2
|
||||
displayName: 'Use .Net Core sdk 5.0.x'
|
||||
inputs:
|
||||
version: 5.0.x
|
||||
|
||||
- powershell: 'sqllocaldb start mssqllocaldb'
|
||||
displayName: 'Start MSSQL LocalDb'
|
||||
|
||||
- task: DotNetCoreCLI@2
|
||||
displayName: 'dotnet test'
|
||||
inputs:
|
||||
command: test
|
||||
projects: '**\Umbraco.Tests.Integration.csproj'
|
||||
|
||||
- job: Build_Artifacts
|
||||
displayName: 'Build Artifacts'
|
||||
pool:
|
||||
vmImage: 'windows-latest'
|
||||
steps:
|
||||
|
||||
- task: UseDotNet@2
|
||||
displayName: 'Use .Net Core sdk 5.0.x'
|
||||
inputs:
|
||||
version: 5.0.x
|
||||
|
||||
- task: NuGetToolInstaller@1
|
||||
displayName: 'Use NuGet Latest'
|
||||
|
||||
- task: NuGetCommand@2
|
||||
displayName: 'Restore NuGet Packages'
|
||||
inputs:
|
||||
restoreSolution: '*\src\umbraco.sln'
|
||||
feedsToUse: config
|
||||
|
||||
- task: PowerShell@1
|
||||
displayName: 'Update Version'
|
||||
condition: eq(variables['Umbraco.IsReleaseBuild'], 'false')
|
||||
inputs:
|
||||
scriptType: inlineScript
|
||||
inlineScript: |
|
||||
Write-Host "Working folder: $pwd"
|
||||
$ubuild = build/build.ps1 -get -continue
|
||||
|
||||
$version = $ubuild.GetUmbracoVersion()
|
||||
if ($version.Comment -ne "")
|
||||
{
|
||||
# 8.0.0-beta.33.1234
|
||||
$continuous = "$($version.Semver).$(Build.BuildNumber)"
|
||||
}
|
||||
else
|
||||
{
|
||||
# 8.0.0-alpha.1234
|
||||
$continuous = "$($version.Release)-alpha.$(Build.BuildNumber)"
|
||||
}
|
||||
$ubuild.SetUmbracoVersion($continuous)
|
||||
|
||||
#Update the version in template also
|
||||
$templatePath = 'build/templates/UmbracoSolution/.template.config/template.json'
|
||||
$a = Get-Content $templatePath -raw | ConvertFrom-Json
|
||||
$a.symbols.version.defaultValue = $continuous
|
||||
$a | ConvertTo-Json -depth 32| set-content $templatePath
|
||||
|
||||
Write-Host "Building: $continuous"
|
||||
|
||||
- task: PowerShell@1
|
||||
displayName: 'Prepare Build'
|
||||
inputs:
|
||||
scriptType: inlineScript
|
||||
inlineScript: |
|
||||
Write-Host "Working folder: $pwd"
|
||||
$ubuild = build\build.ps1 -get
|
||||
|
||||
$ubuild.PrepareBuild("vso")
|
||||
|
||||
- task: NodeTool@0
|
||||
displayName: 'Use Node 11.x'
|
||||
inputs:
|
||||
versionSpec: 11.x
|
||||
|
||||
- task: Npm@1
|
||||
displayName: 'npm install'
|
||||
inputs:
|
||||
workingDir: src\Umbraco.Web.UI.Client
|
||||
verbose: false
|
||||
|
||||
- task: gulp@0
|
||||
displayName: 'gulp build'
|
||||
inputs:
|
||||
gulpFile: src\Umbraco.Web.UI.Client\gulpfile.js
|
||||
targets: build
|
||||
workingDirectory: src\Umbraco.Web.UI.Client
|
||||
publishJUnitResults: true
|
||||
testResultsFiles: '**\TESTS-*.xml'
|
||||
|
||||
- task: PowerShell@1
|
||||
displayName: 'Prepare Packages & Zip'
|
||||
inputs:
|
||||
scriptType: inlineScript
|
||||
inlineScript: |
|
||||
Write-Host "Working folder: $pwd"
|
||||
$ubuild = build\build.ps1 -get -continue
|
||||
|
||||
$ubuild.CompileUmbraco()
|
||||
$ubuild.PreparePackages()
|
||||
$ubuild.PackageZip()
|
||||
|
||||
- task: CopyFiles@2
|
||||
displayName: 'Copy Zip Files to Staging'
|
||||
inputs:
|
||||
SourceFolder: build.out
|
||||
Contents: '*.zip'
|
||||
TargetFolder: '$(build.artifactstagingdirectory)'
|
||||
CleanTargetFolder: true
|
||||
|
||||
- task: PublishBuildArtifacts@1
|
||||
displayName: 'Publish Zip Files'
|
||||
inputs:
|
||||
PathtoPublish: '$(build.artifactstagingdirectory)'
|
||||
ArtifactName: zips
|
||||
|
||||
- task: PowerShell@1
|
||||
displayName: 'Verify & Package NuGet'
|
||||
inputs:
|
||||
scriptType: inlineScript
|
||||
inlineScript: |
|
||||
Write-Host "Working folder: $pwd"
|
||||
$ubuild = build\build.ps1 -get -continue
|
||||
|
||||
$ubuild.VerifyNuGet()
|
||||
$ubuild.PackageNuGet()
|
||||
|
||||
- task: CopyFiles@2
|
||||
displayName: 'Copy NuPkg Files to Staging'
|
||||
inputs:
|
||||
SourceFolder: build.out
|
||||
Contents: '*.nupkg'
|
||||
TargetFolder: '$(build.artifactstagingdirectory)'
|
||||
CleanTargetFolder: true
|
||||
|
||||
- task: PublishBuildArtifacts@1
|
||||
displayName: 'Publish NuPkg Files'
|
||||
inputs:
|
||||
PathtoPublish: '$(build.artifactstagingdirectory)'
|
||||
ArtifactName: nupkg
|
||||
|
||||
- task: CopyFiles@2
|
||||
displayName: 'Copy Log Files to Staging'
|
||||
inputs:
|
||||
SourceFolder: build.tmp
|
||||
Contents: '*.log'
|
||||
TargetFolder: '$(build.artifactstagingdirectory)'
|
||||
CleanTargetFolder: true
|
||||
condition: succeededOrFailed()
|
||||
|
||||
- task: PublishBuildArtifacts@1
|
||||
displayName: 'Publish Log Files'
|
||||
inputs:
|
||||
PathtoPublish: '$(build.artifactstagingdirectory)'
|
||||
ArtifactName: logs
|
||||
condition: succeededOrFailed()
|
||||
- job: Generate_Docs_JS
|
||||
timeoutInMinutes: 60
|
||||
displayName: Generate JS Docs
|
||||
pool:
|
||||
vmImage: windows-latest
|
||||
steps:
|
||||
- task: PowerShell@2
|
||||
displayName: Prep build tool - JS Docs
|
||||
inputs:
|
||||
targetType: inline
|
||||
script: |
|
||||
$uenv=./build.ps1 -get -doc
|
||||
$uenv.SandboxNode()
|
||||
$uenv.CompileBelle()
|
||||
$uenv.PrepareAngularDocs()
|
||||
$uenv.RestoreNode()
|
||||
errorActionPreference: continue
|
||||
workingDirectory: build
|
||||
- task: PublishPipelineArtifact@1
|
||||
displayName: Publish to artifacts - JS Docs
|
||||
inputs:
|
||||
targetPath: $(Build.Repository.LocalPath)\build.out\
|
||||
artifact: docs
|
||||
publishLocation: pipeline
|
||||
|
||||
@@ -1,10 +1,8 @@
|
||||
apiRules:
|
||||
- include:
|
||||
uidRegex: ^Umbraco\.Core
|
||||
- exclude:
|
||||
uidRegex: ^umbraco\.Web\.org
|
||||
uidRegex: ^Umbraco\.Cms
|
||||
- include:
|
||||
uidRegex: ^Umbraco\.Web
|
||||
uidRegex: ^Umbraco\.Extensions
|
||||
- exclude:
|
||||
hasAttribute:
|
||||
uid: System.ComponentModel.EditorBrowsableAttribute
|
||||
@@ -13,6 +11,6 @@ apiRules:
|
||||
- exclude:
|
||||
uidRegex: ^umbraco\.
|
||||
- exclude:
|
||||
uidRegex: ^CookComputing\.
|
||||
uidRegex: ^CookComputing\.
|
||||
- exclude:
|
||||
uidRegex: ^.*$
|
||||
uidRegex: ^.*$
|
||||
|
||||
@@ -2,15 +2,20 @@
|
||||
"metadata": [
|
||||
{
|
||||
"src": [
|
||||
{
|
||||
{
|
||||
"src": "../",
|
||||
"files": [
|
||||
"Umbraco.Core/Umbraco.Core.csproj",
|
||||
"Umbraco.Web/Umbraco.Web.csproj"
|
||||
"**/*.csproj",
|
||||
"**/Umbraco.Infrastructure/**/*.cs"
|
||||
],
|
||||
"exclude": [
|
||||
"**/obj/**",
|
||||
"**/bin/**"
|
||||
"**/bin/**",
|
||||
"**/Umbraco.Web.csproj",
|
||||
"**/Umbraco.Infrastructure.csproj",
|
||||
"**/Umbraco.Web.UI.csproj",
|
||||
"**/Umbraco.Web.UI.Netcore.csproj",
|
||||
"**/**.Test**/*.csproj"
|
||||
]
|
||||
}
|
||||
],
|
||||
@@ -53,7 +58,7 @@
|
||||
"_enableSearch": true,
|
||||
"_disableContribution": false
|
||||
},
|
||||
"dest": "../../build.tmp/_site",
|
||||
"dest": "_site",
|
||||
"template": [
|
||||
"default", "umbracotemplate"
|
||||
]
|
||||
|
||||
@@ -3,5 +3,9 @@
|
||||
|
||||
## Quick Links:
|
||||
|
||||
### [Umbraco.Core](api/Umbraco.Core.html) docs
|
||||
### [Umbraco.Web](api/Umbraco.Web.html) docs
|
||||
### [Core](api/Umbraco.Cms.Core.html) docs
|
||||
### [Infrastructure](api/Umbraco.Cms.Infrastructure.html) docs
|
||||
### [Web](api/Umbraco.Cms.Web.Common.html) docs
|
||||
### [Extensions](api/Umbraco.Extensions.html) docs
|
||||
|
||||
|
||||
|
||||
@@ -1,5 +1,9 @@
|
||||
- name: Core
|
||||
href: api/Umbraco.Cms.Core.html
|
||||
- name: Infrastructure
|
||||
href: api/Umbraco.Cms.Infrastructure.html
|
||||
- name: Web
|
||||
href: api/Umbraco.Cms.Web.Common.html
|
||||
- name: Extensions
|
||||
href: api/Umbraco.Extensions.html
|
||||
|
||||
- name: Umbraco.Core Documentation
|
||||
href: https://our.umbraco.com/apidocs/csharp/api/Umbraco.Core.html
|
||||
- name: Umbraco.Web Documentation
|
||||
href: https://our.umbraco.com/apidocs/csharp/api/Umbraco.Web.html
|
||||
@@ -9,7 +9,7 @@
|
||||
<span class="icon-bar"></span>
|
||||
<span class="icon-bar"></span>
|
||||
</button>
|
||||
<a class="navbar-brand" href="/" alt="Our Umbraco"></a>
|
||||
<a class="navbar-brand" href="{{_rel}}" alt="Our Umbraco"></a>
|
||||
</div>
|
||||
<div class="collapse navbar-collapse" id="navbar">
|
||||
<form class="navbar-form navbar-right" role="search" id="search">
|
||||
|
||||
@@ -4,7 +4,7 @@ using System.Collections.Generic;
|
||||
namespace Umbraco.Cms.Core.Models.Membership
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents an entity -> user group & permission key value pair collection
|
||||
/// Represents an entity -> user group & permission key value pair collection
|
||||
/// </summary>
|
||||
public class EntityPermissionSet
|
||||
{
|
||||
|
||||
@@ -9,7 +9,7 @@ namespace Umbraco.Cms.Core.Logging.Serilog.Enrichers
|
||||
/// <summary>
|
||||
/// Enrich log events with a HttpRequestId GUID.
|
||||
/// Original source - https://github.com/serilog-web/classic/blob/master/src/SerilogWeb.Classic/Classic/Enrichers/HttpRequestIdEnricher.cs
|
||||
/// Nupkg: 'Serilog.Web.Classic' contains handlers & extra bits we do not want
|
||||
/// Nupkg: 'Serilog.Web.Classic' contains handlers and extra bits we do not want
|
||||
/// </summary>
|
||||
public class HttpRequestIdEnricher : ILogEventEnricher
|
||||
{
|
||||
|
||||
@@ -10,7 +10,7 @@ namespace Umbraco.Cms.Core.Logging.Serilog.Enrichers
|
||||
/// Enrich log events with a HttpRequestNumber unique within the current
|
||||
/// logging session.
|
||||
/// Original source - https://github.com/serilog-web/classic/blob/master/src/SerilogWeb.Classic/Classic/Enrichers/HttpRequestNumberEnricher.cs
|
||||
/// Nupkg: 'Serilog.Web.Classic' contains handlers & extra bits we do not want
|
||||
/// Nupkg: 'Serilog.Web.Classic' contains handlers and extra bits we do not want
|
||||
/// </summary>
|
||||
public class HttpRequestNumberEnricher : ILogEventEnricher
|
||||
{
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
using Serilog.Core;
|
||||
using System;
|
||||
using Serilog.Core;
|
||||
using Serilog.Events;
|
||||
using System;
|
||||
using Umbraco.Cms.Core.Net;
|
||||
|
||||
namespace Umbraco.Cms.Core.Logging.Serilog.Enrichers
|
||||
@@ -8,7 +8,7 @@ namespace Umbraco.Cms.Core.Logging.Serilog.Enrichers
|
||||
/// <summary>
|
||||
/// Enrich log events with the HttpSessionId property.
|
||||
/// Original source - https://github.com/serilog-web/classic/blob/master/src/SerilogWeb.Classic/Classic/Enrichers/HttpSessionIdEnricher.cs
|
||||
/// Nupkg: 'Serilog.Web.Classic' contains handlers & extra bits we do not want
|
||||
/// Nupkg: 'Serilog.Web.Classic' contains handlers and extra bits we do not want
|
||||
/// </summary>
|
||||
public class HttpSessionIdEnricher : ILogEventEnricher
|
||||
{
|
||||
|
||||
@@ -9,7 +9,7 @@ using Umbraco.Extensions;
|
||||
namespace Umbraco.Cms.Core.Logging.Serilog
|
||||
{
|
||||
///<summary>
|
||||
/// Implements <see cref="ILogger"/> on top of Serilog.
|
||||
/// Implements MS ILogger on top of Serilog.
|
||||
///</summary>
|
||||
public class SerilogLogger : IDisposable
|
||||
{
|
||||
|
||||
@@ -22,7 +22,7 @@ namespace Umbraco.Cms.Core.Logging.Viewer
|
||||
|
||||
/// <summary>
|
||||
/// A count of number of errors
|
||||
/// By counting Warnings with Exceptions, Errors & Fatal messages
|
||||
/// By counting Warnings with Exceptions, Errors & Fatal messages
|
||||
/// </summary>
|
||||
int GetNumberOfErrors(LogTimePeriod logTimePeriod);
|
||||
|
||||
|
||||
@@ -48,7 +48,7 @@ namespace Umbraco.Cms.Core.Persistence.Repositories
|
||||
|
||||
/// <summary>
|
||||
/// Used to bulk update the permissions set for a content item. This will replace all permissions
|
||||
/// assigned to an entity with a list of user id & permission pairs.
|
||||
/// assigned to an entity with a list of user id & permission pairs.
|
||||
/// </summary>
|
||||
/// <param name="permissionSet"></param>
|
||||
void ReplaceContentPermissions(EntityPermissionSet permissionSet);
|
||||
|
||||
@@ -2,8 +2,8 @@ using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using Microsoft.AspNetCore.Mvc.ApplicationModels;
|
||||
using Umbraco.Cms.Core.Models.PublishedContent;
|
||||
using Umbraco.Cms.Web.Common.Controllers;
|
||||
using Umbraco.Extensions;
|
||||
using Umbraco.Web.Common.Controllers;
|
||||
|
||||
namespace Umbraco.Cms.Web.Common.ApplicationModels
|
||||
{
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
using Microsoft.AspNetCore.Mvc.Filters;
|
||||
using Umbraco.Cms.Core.Models.PublishedContent;
|
||||
|
||||
namespace Umbraco.Web.Common.Controllers
|
||||
namespace Umbraco.Cms.Web.Common.Controllers
|
||||
{
|
||||
/// <summary>
|
||||
/// Used for custom routed controllers to execute within the context of Umbraco
|
||||
|
||||
@@ -9,8 +9,8 @@ using Microsoft.Extensions.DependencyInjection;
|
||||
using Umbraco.Cms.Core.Models.PublishedContent;
|
||||
using Umbraco.Cms.Core.Routing;
|
||||
using Umbraco.Cms.Core.Web;
|
||||
using Umbraco.Cms.Web.Common.Controllers;
|
||||
using Umbraco.Cms.Web.Common.Routing;
|
||||
using Umbraco.Web.Common.Controllers;
|
||||
|
||||
namespace Umbraco.Cms.Web.Common.Filters
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user