AZ-400 Question 47
Select 2You are a DevOps engineer responsible for automating the documentation process for your organization's microservices. Each new release must include automatically generated release notes from Git commit messages and updated API documentation from a shared OpenAPI specification. You want to publish the release notes to an internal wiki and store the API documentation artifacts for consumption by other teams. Which two configurations should you implement to meet these requirements?
- A
Set up a specialized Azure DevOps extension to generate release notes from commit messages and publish them directly to the existing wiki as part of the release pipeline.
- B
Include a task in the build or release pipeline that uses a tool like Swagger Codegen or a similar generator to update API documentation from the OpenAPI spec and publish it as an artifact.
- C
Create and upload release notes as a Word document at the end of the sprint, attaching it manually to the release pipeline before deployment.
- D
Use Azure DevOps to create a new repository for every release and commit the generated release notes and API documentation there.
Show answer and explanation
Correct answers: A, B
Explanation
Using automated tasks in the release pipeline for both release note generation and API doc generation aligns with DevOps best practices: it reduces manual steps, ensures consistency, and makes the most recent information readily available. Extensions such as 'Generate Release Notes' in Azure DevOps work well for creating release notes from commits or work items, while OpenAPI-based tools (e.g., Swagger Codegen) allow you to produce current API documentation before publishing it as artifacts. For more guidance, refer to Azure DevOps documentation on 'Generate release notes from the release pipeline' and 'Automate API documentation with OpenAPI.'
- A. Correct.
Correct. Many Azure DevOps extensions can automatically parse Git commit messages, pull requests, or work items to generate release notes. Publishing these generated notes to your organization's internal wiki in the same pipeline run ensures consistency and reduces manual effort.
- B. Correct.
Correct. Tools like Swagger Codegen or other OpenAPI-based documentation generators can be scripted in your CI/CD pipeline to produce up-to-date API docs. Storing these docs as artifacts or publishing them to an internal feed allows teams to easily access the latest API changes.
- C. Incorrect.
Incorrect. Manually attaching a Word document for release notes introduces a high risk of human error and inconsistency. It also lacks the automated, traceable flow that DevOps pipelines aim to provide, making maintenance more difficult.
- D. Incorrect.
Incorrect. Creating a repository for every release adds unnecessary overhead. It also fragments release notes and documentation across multiple repos, making it harder for stakeholders to find and consume the latest information.