Bitzu

AZ-400 ยท Documentation and collaboration

GitHub automatically generated release notes

Generating release notes and changelogs from commits, tags, PRs and work items; GitHub automatically generated release notes; API documentation generation (OpenAPI).

Key points

  • When you draft a release, Generate release notes builds the text from merged pull requests, lists the contributors and links to the full changelog; you can pick a previous tag as the comparison point.
  • A .github/release.yml file shapes the result: categories group PRs by label, and exclusions drop PRs by label or author (for example bots).

Source: https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes

Practice questions

Single choice

Which file in a GitHub repository customizes the structure of automatically generated release notes?

  1. .github/release.yml
  2. .github/CODEOWNERS
  3. CHANGELOG.config
  4. .github/dependabot.yml
Show answer

Answer: A. .github/release.yml

The configuration lives in .github/release.yml. Workflow files under .github/workflows run automation but do not define note categories.

Select all that apply

What does a GitHub auto-generated release notes draft contain?

  1. Merged pull requests
  2. A list of contributors
  3. A link to the full changelog
  4. Azure Boards sprint burndown
  5. Build agent log output
Show answer

Answer: A. Merged pull requests, B. A list of contributors, C. A link to the full changelog

The draft is built from merged pull requests, the contributors and a changelog link. Sprint burndown data and agent logs live in other systems and are not inputs.

True or false

True or false: GitHub's generated release notes list every commit pushed directly to the branch, even without a pull request.

Show answer

Answer: False

False. The notes are built from merged pull requests, so direct pushes without a PR do not appear as entries.

Practice 8 questions on this topic in Bitzu

Short lessons, instant explanations and spaced review of what you get wrong. Free on iOS and Android.

Download on the App StoreGet it on Google Play

More AZ-400 topics in this module