Azure DevOps Wiki.
При работе на Azure DevOps или Github у нас есть особые потребности, когда речь идет о вики и документации. В частности, у нас часто наша документация сидела рядом с нашим исходным кодом в наших репос, что позволяет нам версию нашу документацию вместе с нашим исходным кодом. Этот рабочий процесс, специфичный разработчик полностью поддерживается Azure DevOps Wiki. Что великолепно использовать Azure DevOps Wiki, это то, что аналогичным образом, как команды могут поделиться и сотрудничать в исходном коде для проектов ту же команду, используя тот же рабочий процесс, также может делиться и сотрудничать в документации проектов через свою вики. Документация, такая как заметка, руководства по выпуску, руководствам и любую документацию, которая должна сопровождать проект, может быть создана в Wiki. Затем документация также хранится в контроле источника и в центральном месте, которое команда может получить доступ и сотрудничать.
Но это может быть не подходящим или возможно во все времена во всех случаях использования, например, для того, чтобы увидеть DEVOPS Wiki, который должен иметь доступ к проекту DevOps и Wiki. Скажите, например, кто-то, кто находится в другом проекте или в управленческой роль, который не имеет доступа к проекту DevOps или Wiki, хотел бы видеть заметки выпуска продукции или, возможно, какую-то документу на проекте в документе, это делает вещи немного более сложный. Итак, сегодня я поделюсь с вами, как вы можете конвертировать ваши DevOps или Github Wiki в документ PDF. Мы также посмотрим, как мы можем создать конвейер, который автоматически генерирует новый документ «Wiki PDF» при необходимости.
DevOps Wiki PDF Эктуальная задача
Экспортные задачи Wiki PDF — это расширение DEVOPS, которое может быть установлено в вашу Организацию DEVOPS от DEVOPS AZURE Рынок , Проще говоря, это расширение лазурных трубопроводов, которые могут дать команды другим способом представить свои Wiki в качестве документа PDF, будь то экспорт целую вики или только одну страницу.
Расширение основано на инструменте под названием Azuredevops. Wikipdfexport Max Melcher, который позволяет экспортировать целый Wiki (или один файл) в качестве PDF. Инструмент выполняет следующие задачи:
- Клонировать вики Репо
- Запустите инструмент командной строки, проходящей в пути к корню клонированного вики Repo
- Файл. Заказ прочитан
- PDF генерируется
Wiki To PDF-трубопровод
После установки Wiki PDF Экспортные задачи В вашей Организации DEVOPS. Перейдите к вашему вики-хранилищу. В этом руководстве я использую репо на моем проекте под названием: Дежол. Вики Опубликовано как мой проект Wiki.
Под моим репо я тогда создал новую папку/путь под названием: .Pipelines
На этом пути мы создадим наш трубопровод YAML под названием Wiki-to-pdf.yml со следующим кодом:
# code/wiki-to-pdf.yml
name: Wiki-To-PDF-$(Rev:rr)
trigger: none
stages:
- stage: wiki_export
displayName: Wiki Export
jobs:
- job: wiki_to_pdf
displayName: Wiki To PDF
pool:
vmImage: windows-latest
steps:
- task: UseDotNet@2
displayName: 'Use .NET Core sdk'
inputs:
packageType: 'sdk'
version: '6.0.x'
includePreviewVersions: true
- task: richardfennellBM.BM-VSTS-WikiPDFExport-Tasks.WikiPDFExportTask.WikiPdfExportTask@2
displayName: 'Export a private Azure DevOps WIKI'
inputs:
cloneRepo: true
repo: 'https://dev.azure.com/magiconionM/Devto_Blog_Demos/_git/DevOps.Wiki'
useAgentToken: true
localpath: '$(System.DefaultWorkingDirectory)/DevOpsWiki'
outputFile: '$(Build.ArtifactStagingDirectory)/PDF/DevOpsWiki.pdf'
- task: PublishPipelineArtifact@1
displayName: 'Publish wiki export to Azure Pipeline'
inputs:
targetPath: '$(Build.ArtifactStagingDirectory)/PDF'
artifactName: DevOpsWiki
Затем мы можем настроить этот конвейер и вызвать его вручную, после завершения трубопровода будет генерировать артефакт, который содержит документ PDF.
Здесь является примером экспорта PDF.
Другие примеры
Примечание. На нашем трубопроводе используется задача специально для экспорта частного Azure DevOps Wiki:
- task: richardfennellBM.BM-VSTS-WikiPDFExport-Tasks.WikiPDFExportTask.WikiPdfExportTask@2
displayName: 'Export a private Azure DevOps WIKI'
inputs:
cloneRepo: true
repo: 'https://dev.azure.com/magiconionM/Devto_Blog_Demos/_git/DevOps.Wiki'
useAgentToken: true
localpath: '$(System.DefaultWorkingDirectory)/DevOpsWiki'
outputFile: '$(Build.ArtifactStagingDirectory)/PDF/DevOpsWiki.pdf'
Вот еще два примера. Экспорт один файл:
- task: richardfennellBM.BM-VSTS-WikiPDFExport-Tasks.WikiPDFExportTask.WikiPdfExportTask@2
displayName: 'Export Single File'
inputs:
cloneRepo: false
usePreRelease: false
localpath: '$(System.DefaultWorkingDirectory)'
singleFile: 'release_notes.md'
outputFile: '$(Build.ArtifactStagingDirectory)/PDF/ReleaseNotes.pdf'
Экспорт публичного GitHub Wiki:
- task: richardfennellBM.BM-VSTS-WikiPDFExport-Tasks.WikiPDFExportTask.WikiPdfExportTask@2
displayName: 'Export a public GitHub WIKI'
inputs:
cloneRepo: true
repo: 'https://github.com/rfennell/AzurePipelines.wiki.git'
useAgentToken: false
localpath: '$(System.DefaultWorkingDirectory)\GitHubRepo'
outputFile: '$(Build.ArtifactStagingDirectory)\PDF\GitHubWiki.pdf'
ПРИМЕЧАНИЕ: Этот пост блога был обновлен, чтобы отразить изменения в V2 задания/расширения. Azuredevops. Wikipdfexport Инструмент с 4.0,0 это .Net6. основанный. Следовательно, .Net6. должен быть установлен на агенте.
Это может быть легко сделать, используя следующую задачу построения трубопровода, как показано на конфигурации YAML, до вызова расширения.
# code/wiki-to-pdf.yml#L15-L20
- task: UseDotNet@2
displayName: 'Use .NET Core sdk'
inputs:
packageType: 'sdk'
version: '6.0.x'
includePreviewVersions: true
Я надеюсь, что вы наслаждались этим постом и узнали что-то новое. Вы также можете найти образцы кода, используемые в этом сообщении в блоге, на моем Github страница. ❤ ️
Автор
Вроде, поделиться, следуй за мной: 🐙 Github |. 🐧 Twitter |. 👾 Linkedin.
Марсель Легов
Оригинал: «https://dev.to/pwd9000/create-a-pdf-document-from-an-azure-devops-wiki-fjh»