Azure DevOps Wiki에서 PDF 문서 만들기

Azure DevOps 위키

Azure DevOps 또는 Github에서 작업할 때 Wiki 및 설명서와 관련하여 특별한 요구 사항이 있습니다. 특히, 우리는 종종 문서를 저장소의 소스 코드 옆에 두어 소스 코드와 함께 문서의 버전을 지정할 수 있습니다. 이 개발자별 워크플로는 Azure DevOps Wiki에서 전적으로 지원됩니다. Azure DevOps wiki를 사용할 때 좋은 점은 팀이 동일한 워크플로를 사용하여 동일한 팀이 프로젝트 소스 코드를 공유하고 공동 작업할 수 있는 방법과 유사하게 해당 Wiki를 통해 프로젝트 문서를 공유하고 공동 작업할 수 있다는 것입니다. 릴리스 노트, 매뉴얼 및 프로젝트에 수반되어야 하는 모든 종류의 문서와 같은 문서를 Wiki에서 만들 수 있습니다. 그런 다음 문서는 소스 제어 및 팀이 액세스하고 협업할 수 있는 중앙 위치에 보관됩니다.

그러나 이것은 모든 사용 사례에서 항상 적합하지 않거나 가능하지 않을 수 있습니다. 예를 들어 DevOps wiki를 보려면 DevOps 프로젝트 및 Wiki에 대한 액세스 권한이 있어야 합니다. 예를 들어 다른 프로젝트에 있거나 DevOps 프로젝트 또는 Wiki에 대한 액세스 권한이 없는 관리 역할에 있는 사람이 제품 릴리스 정보 또는 문서의 프로젝트에 대한 일종의 문서를 보고 싶어한다고 가정해 보겠습니다. 조금 더 까다롭습니다. 그래서 오늘은 DevOps 또는 Github 위키를 PDF 문서로 변환하는 방법을 알려드리겠습니다. 또한 필요할 때 새 "Wiki PDF"문서를 자동으로 생성하는 파이프라인을 만드는 방법도 살펴보겠습니다.

DevOps Wiki PDF 내보내기 작업

WIKI PDF 내보내기 작업은 Azure DevOps에서 DevOps 조직에 설치할 수 있는 DevOps 확장입니다marketplace. 전체 WIKI 또는 단일 페이지 내보내기.

확장 프로그램은 전체 WIKI(또는 단일 파일)를 PDF로 내보낼 수 있는 Max Melcher의 AzureDevOps.WikiPDFExport이라는 도구를 기반으로 합니다. 이 도구는 다음 작업을 수행합니다.

WIKI 리포지토리 복제

복제된 wiki repo의 루트에 대한 경로를 전달하는 명령줄 도구를 실행합니다

.

.order 파일을 읽습니다

.

PDF가 생성됨

위키-PDF 파이프라인

Devops 조직에 WIKI PDF Export Tasks을 설치한 후. Wiki 저장소로 이동합니다.
이 튜토리얼에서는 내 프로젝트 위키로 게시된 Devops.Wiki라는 내 프로젝트의 리포지토리를 사용하고 있습니다.



내 저장소 아래에 다음과 같은 새 폴더/경로를 만들었습니다. .pipelines


이 경로에서 다음 코드를 사용하여 wiki-to-pdf.yml라는 YAML 파이프라인을 생성합니다.

# 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 문서가 포함된 아티팩트가 생성됩니다.





Here은 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 변경 사항을 반영하도록 업데이트되었습니다. 4.0.0 이후의 AzureDevOps.WikiPDFExport 도구는 .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 | 🐧 | 👾


.ltag__user__id__620034 .follow-action-button {
배경색: #0cbb58 !중요;
색상: #000000 !중요;
border-color: #0cbb58 !중요;
}

Marcel.L 팔로우

Cloud Solutions & DevOps Architect.