Skip to content

Commit 13b77d3

Browse files
authored
V14: Build and publish Typedoc docs (#16724)
* rename display names of 'ui docs' to 'storybook' * add new jobs to build and publish the ui-api docs (typedoc) to the blob storage
1 parent ecd6e05 commit 13b77d3

File tree

1 file changed

+41
-4
lines changed

1 file changed

+41
-4
lines changed

build/azure-pipelines.yml

Lines changed: 41 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -217,16 +217,30 @@ stages:
217217
displayName: Replace BASE_PATH on assets
218218
workingDirectory: $(Build.SourcesDirectory)/src/Umbraco.Web.UI.Client/storybook-static
219219
- task: ArchiveFiles@2
220-
displayName: Archive js Docs
220+
displayName: Archive Storybook
221221
inputs:
222222
rootFolderOrFile: $(Build.SourcesDirectory)/src/Umbraco.Web.UI.Client/storybook-static
223223
includeRootFolder: false
224224
archiveFile: $(Build.ArtifactStagingDirectory)/ui-docs.zip
225225
- task: PublishPipelineArtifact@1
226-
displayName: Publish js Docs
226+
displayName: Publish Storybook
227227
inputs:
228228
targetPath: $(Build.ArtifactStagingDirectory)/ui-docs.zip
229229
artifact: ui-docs
230+
- script: npm run generate:ui-api-docs
231+
displayName: Generate API Docs
232+
workingDirectory: $(Build.SourcesDirectory)/src/Umbraco.Web.UI.Client
233+
- task: ArchiveFiles@2
234+
displayName: Archive UI API Docs
235+
inputs:
236+
rootFolderOrFile: $(Build.SourcesDirectory)/src/Umbraco.Web.UI.Client/ui-api
237+
includeRootFolder: false
238+
archiveFile: $(Build.ArtifactStagingDirectory)/ui-api-docs.zip
239+
- task: PublishPipelineArtifact@1
240+
displayName: Publish UI API Docs
241+
inputs:
242+
targetPath: $(Build.ArtifactStagingDirectory)/ui-api-docs.zip
243+
artifact: ui-api-docs
230244

231245
###############################################
232246
## Test
@@ -846,7 +860,7 @@ stages:
846860
BlobPrefix: v$(umbracoMajorVersion)/csharp
847861
CleanTargetBeforeCopy: true
848862
- job:
849-
displayName: Upload js Docs
863+
displayName: Upload Storybook
850864
steps:
851865
- checkout: none
852866
- task: DownloadPipelineArtifact@2
@@ -859,7 +873,7 @@ stages:
859873
archiveFilePatterns: $(Build.SourcesDirectory)/ui-docs.zip
860874
destinationFolder: $(Build.ArtifactStagingDirectory)/ui-docs
861875
- task: AzureFileCopy@4
862-
displayName: 'Copy UI Docs to blob storage'
876+
displayName: 'Copy Storybook to blob storage'
863877
inputs:
864878
SourcePath: '$(Build.ArtifactStagingDirectory)/ui-docs/*'
865879
azureSubscription: umbraco-storage
@@ -868,3 +882,26 @@ stages:
868882
ContainerName: '$web'
869883
BlobPrefix: v$(umbracoMajorVersion)/ui
870884
CleanTargetBeforeCopy: true
885+
- job:
886+
displayName: Upload UI API Docs
887+
steps:
888+
- checkout: none
889+
- task: DownloadPipelineArtifact@2
890+
displayName: Download artifact
891+
inputs:
892+
artifact: ui-api-docs
893+
path: $(Build.SourcesDirectory)
894+
- task: ExtractFiles@1
895+
inputs:
896+
archiveFilePatterns: $(Build.SourcesDirectory)/ui-api-docs.zip
897+
destinationFolder: $(Build.ArtifactStagingDirectory)/ui-api-docs
898+
- task: AzureFileCopy@4
899+
displayName: 'Copy UI API Docs to blob storage'
900+
inputs:
901+
SourcePath: '$(Build.ArtifactStagingDirectory)/ui-api-docs/*'
902+
azureSubscription: umbraco-storage
903+
Destination: AzureBlob
904+
storage: umbracoapidocs
905+
ContainerName: '$web'
906+
BlobPrefix: v$(umbracoMajorVersion)/ui-api
907+
CleanTargetBeforeCopy: true

0 commit comments

Comments
 (0)