Collaboration: Wikis, Teams & Release Notes

Why Documentation and Integration Matter

Project Wikis: Azure DevOps

Azure DevOps offers two types of wikis. Knowing the difference is exam-critical.

Azure DevOps Wiki Types

Feature	Project Wiki (Provisioned)	Code Wiki (Published)
Created by	Provisioned from the Wiki hub — one per project	Published from a folder in any Git repository
Count limit	One provisioned wiki per project	Unlimited code wikis per project
Storage	Stored in a hidden Git repo managed by Azure DevOps	Stored in your existing repository alongside code
Editing	Rich editor in browser OR Markdown files via Git	Edit as files in any code editor or IDE
Versioning	Git-backed with full history	Follows the branch — different branches can have different docs
Page hierarchy	Drag-and-drop page reordering in the wiki UI	Folder structure defines page hierarchy with .order files
Best for	General project documentation managed by PMs and leads	Technical documentation that lives with the codebase
Mermaid support	Yes — inline in Markdown	Yes — inline in Markdown

Mermaid Diagrams in Wikis

Both wiki types support Mermaid diagrams rendered from text. The exam expects you to recognise Mermaid syntax and know which diagram types are supported.

Common Mermaid diagrams for DevOps:

• Flowcharts — CI/CD pipeline flow, decision trees
• Sequence diagrams — API call flows, deployment approval sequences
• Gantt charts — project timelines, sprint plans
• State diagrams — work item state transitions
• Git graph — branching strategy visualisation

A Mermaid block in an Azure DevOps wiki looks like this:

:::mermaid
graph LR
    A[Code Push] --> B[CI Build]
    B --> C[Unit Tests]
    C --> D[Security Scan]
    D --> E[Deploy to Staging]
    E --> F[Integration Tests]
    F --> G[Deploy to Production]
:::

Question

How many provisioned wikis can an Azure DevOps project have? How many code wikis?

Click or press Enter to reveal answer

Answer

One provisioned (project) wiki per project. Unlimited code wikis per project — each published from a different repository folder or branch. This means you can have separate code wikis for API docs, architecture docs, runbooks, etc., all within the same project.

Click to flip back

🏢 Nadia’s Wiki Strategy

Nadia uses both wiki types at Meridian Insurance:

• Project Wiki — onboarding guides, team agreements, sprint ceremonies, escalation procedures
• Code Wiki (API repo) — auto-generated API docs from the docs/ folder, updated with every PR
• Code Wiki (Infra repo) — architecture diagrams in Mermaid, updated by Jordan’s platform team

Elena (compliance) loves that every wiki change has a Git commit with author and timestamp — instant audit trail.

Automated Release Notes

GitHub: Automatically Generated Release Notes

GitHub can auto-generate release notes from merged pull requests. You configure categories in .github/release.yml:

changelog:
  categories:
    - title: "New Features"
      labels:
        - "enhancement"
        - "feature"
    - title: "Bug Fixes"
      labels:
        - "bug"
        - "fix"
    - title: "Breaking Changes"
      labels:
        - "breaking"
    - title: "Other Changes"
      labels:
        - "*"

When you create a new release on GitHub, clicking “Generate release notes” pulls all merged PRs since the last release, categorises them by label, and lists contributors.

🚀 Kai’s Release Note Automation

Kai configures release.yml so that every GitHub Release automatically:

1. Groups PRs by label (features, fixes, breaking changes)
2. Credits all contributors
3. Excludes PRs with the internal label (refactoring, CI changes)

Riku (frontend dev) just ensures every PR has the right label. Release notes write themselves.

Azure DevOps: Release Notes from Work Items

In Azure DevOps, you generate release notes from:

• Work items linked to builds — query all items resolved since the last release
• Azure DevOps REST API — pull work item details for custom release note templates
• Marketplace extensions — “Generate Release Notes” extension creates Markdown from linked work items
• Azure Pipelines tasks — generate release notes as a pipeline step during deployment

Question

How do you configure automatic release note categories in GitHub?

Click or press Enter to reveal answer

Answer

Create a .github/release.yml file in the repository. Define categories with titles and label filters. When creating a GitHub Release, click 'Generate release notes' — GitHub groups merged PRs by their labels into the categories you defined. PRs not matching any category go into 'Other Changes' if you include a wildcard label.

Click to flip back

API Documentation

For the exam, know that API documentation is typically generated from OpenAPI/Swagger specifications:

• Swagger UI — interactive API explorer generated from an OpenAPI spec
• Swashbuckle (ASP.NET) — auto-generates OpenAPI spec from controller code
• GitHub Pages — host generated API docs as a static site
• Azure API Management — publishes a developer portal with auto-generated API docs from imported OpenAPI specs

Exam Tip: API Documentation Integration

The exam may ask how to ensure API documentation stays in sync with code. The best answer is to generate API docs from code annotations (Swashbuckle for .NET, Springfox for Java, etc.) as part of the CI pipeline. The pipeline generates the OpenAPI spec, then publishes updated docs. This prevents documentation drift because docs are rebuilt on every commit.

Webhooks: Event-Driven Integration

Webhooks allow external systems to be notified when events occur. They’re the backbone of DevOps integration.

Azure DevOps Service Hooks

Azure DevOps uses service hooks (not raw webhooks — the terminology matters). You configure them in Project Settings > Service Hooks.

Supported events include: Work item created/updated, build completed, release deployed, PR created/merged, code pushed

Supported targets include: Slack, Microsoft Teams, Jenkins, Grafana, custom webhook URL, Azure Service Bus, Azure Storage Queue

GitHub Webhooks

GitHub sends HTTP POST requests to a configured URL when events occur.

Configuration: Repository Settings > Webhooks > Add webhook > choose events > specify payload URL

Supported events include: Push, pull request, issues, release, deployment, workflow run, and 30+ other event types

Security: Always validate webhook payloads using the shared secret and HMAC-SHA256 signature in the X-Hub-Signature-256 header.

Question

What is the difference between Azure DevOps service hooks and GitHub webhooks?

Click or press Enter to reveal answer

Answer

Azure DevOps uses 'service hooks' — a managed integration layer with built-in connectors for common targets (Teams, Slack, Jenkins) and a configuration UI. GitHub uses raw webhooks — HTTP POST to any URL when events occur, secured with HMAC-SHA256 signatures. Both achieve event-driven integration, but Azure DevOps provides a more opinionated, managed experience while GitHub gives raw flexibility.

Click to flip back

Azure Boards + GitHub Integration

The Azure Boards GitHub App connects Azure Boards work items to GitHub repositories. This was covered in Module 1, but the integration specifics are tested here too.

Setup: Install the Azure Boards app from GitHub Marketplace > authorise for your organisation > map GitHub repos to Azure DevOps projects.

Key features:

• AB#1234 in commits/PRs creates a link to work item 1234
• Transition states on PR merge (e.g., move to “Done” when PR merges)
• Work item mentions appear in GitHub PR sidebar
• GitHub Commit and PR links appear on the Azure Boards work item

Microsoft Teams Integration

Teams Integration: Azure DevOps vs GitHub

Capability	Azure DevOps + Teams	GitHub + Teams
App name	Azure DevOps app for Microsoft Teams	GitHub for Microsoft Teams app
Setup	Install app in Teams > connect to Azure DevOps org	Install app in Teams > authenticate with GitHub
Notifications	Subscribe to build, release, PR, work item events per channel	Subscribe to issues, PRs, releases, deployments, Actions per channel
Commands	Slash commands: create work items, query items, get pipeline status	Slash commands: open/close issues, subscribe/unsubscribe repos
Previews	Pasting Azure DevOps URLs auto-unfurls with rich cards	Pasting GitHub URLs auto-unfurls with PR status, issue details
Approval workflows	Release approvals in Teams via Adaptive Cards	Deployment environment approvals via notifications
Granularity	Subscribe per project, per repo, or per pipeline	Subscribe per repository or per organisation

🚀 Kai’s Teams Setup

Kai configures three Teams channels at Launchpad Labs:

• #deployments — subscribed to GitHub deployment events (production only)
• #code-reviews — subscribed to PR events (new PRs, reviews requested)
• #incidents — subscribed to GitHub Issues with the incident label

When Riku opens a PR, the #code-reviews channel gets a rich card with the PR title, description, and a direct link. Zoe (QA) sees it immediately.

🏢 Nadia’s Teams Setup

Nadia uses the Azure DevOps app for Teams:

• #releases — subscribed to release deployment completed events
• #build-alerts — subscribed to build failure events (not successes — reducing noise)
• Approval channel — Dmitri receives release approval requests as Adaptive Cards and can approve directly in Teams

Question

How do you configure Azure DevOps to send release approval requests to Microsoft Teams?

Click or press Enter to reveal answer

Answer

Install the Azure DevOps app for Microsoft Teams. Subscribe the channel to release deployment approval events. When a release reaches an approval gate, an Adaptive Card is posted to the Teams channel. The designated approver can approve or reject directly from Teams without opening Azure DevOps.

Click to flip back

Exam Tip: Webhook Security

The exam may ask about securing webhooks. For GitHub, always configure a webhook secret and validate the X-Hub-Signature-256 header using HMAC-SHA256. For Azure DevOps service hooks, use Basic authentication or OAuth when sending to custom endpoints. Never send webhooks to HTTP (unencrypted) endpoints — always use HTTPS.

Knowledge Check

Jordan needs to host technical architecture documentation that stays in sync with the codebase and supports Mermaid diagrams. Which wiki type should Jordan use in Azure DevOps?

AProvisioned project wiki with Mermaid code blocksBCode wiki published from the repository's docs/ folderCSharePoint wiki linked to the Azure DevOps projectDGitHub Wiki with cross-repository sync

Check Answer

Knowledge Check

Kai wants GitHub to auto-generate release notes that group changes into 'Features', 'Bug Fixes', and 'Breaking Changes'. What must he configure?

AA GitHub Actions workflow that parses commit messages using Conventional CommitsBA .github/release.yml file with changelog categories mapped to PR labelsCBranch protection rules that enforce PR title prefixesDA CHANGELOG.md file maintained by a pre-commit hook

Check Answer

Knowledge Check

Dr. Amira's government client requires an audit trail proving who approved each release and when. Which Microsoft Teams integration feature supports this?

AGitHub deployment environment approvals via Teams notificationsBAzure DevOps release approval Adaptive Cards in TeamsCCustom Power Automate flow triggered by Teams messagesDAzure DevOps service hooks posting to a Teams webhook

Check Answer

🎬 Video coming soon

Wikis, Teams & Release Notes

Next up: Branching Strategies: Trunk-Based, Feature & Release