Release Notes Generator

Create a Python program that generates a formatted release notes document with proper text styling.

Requirements

Your program should:

1. Create a Markdown file named release_notes.md

2. Add a title "Version 2.5.0 Release Notes"

3. Generate release notes content with the following sections:

   • A "New Features" section with text describing at least 2 new features
   • A "Bug Fixes" section with text describing at least 2 bug fixes
   • A "Breaking Changes" section with text describing at least 1 breaking change

4. Apply proper text formatting:

   • Feature names should be in bold
   • Technical terms like variable names, function names, or configuration keys should be in inline code format
   • Important warnings or notes should be in italics
   • Use a combination of formatting styles where appropriate (e.g., bold and inline code together)

5. Each section should contain at least 2 paragraphs of text with appropriate formatting

Example Output

Your generated Markdown file should produce output similar to:

# Version 2.5.0 Release Notes

## New Features

**Enhanced Authentication**: Added support for OAuth2 authentication. Configure using the `auth_provider` setting in your configuration file.

**Performance Improvements**: Database queries are now optimized. *Note: This requires re-indexing your database.*

## Bug Fixes

Fixed critical issue in the `process_data` function that caused data corruption. **All users should upgrade immediately.**

Resolved memory leak in *long-running processes*. The `memory_limit` configuration now works correctly.

## Breaking Changes

The `legacy_mode` configuration option has been removed. *Please update your configuration files before upgrading.* Use `compatibility_level` instead.

Dependencies { .dependencies }

mdutils { .dependency }

Provides Markdown file generation capabilities.

Test Cases { .test-cases }

Test 1: Verify file creation { .test-case }

@test

After running your program, the file release_notes.md should exist.

Test 2: Verify title format { .test-case }

@test

The generated file should contain a level 1 header with "Version 2.5.0 Release Notes".

Test 3: Verify bold formatting { .test-case }

@test

The generated file should contain at least 3 instances of bold text (text surrounded by **).

Test 4: Verify inline code formatting { .test-case }

@test

The generated file should contain at least 3 instances of inline code (text surrounded by backticks).

Test 5: Verify italic formatting { .test-case }

@test

The generated file should contain at least 2 instances of italic text (text surrounded by single * or _).

Implementation File

• generate_release_notes.py: Main program file
• test_release_notes.py: Test file for validation