Update sample_release_notes.md with complete release notes template

[Copilot]

Overview

Updated the sample_release_notes.md file to provide a complete, properly formatted example for release notes in the Beacon project.

Changes Made

Added Header Section

• Release version, date, and author information at the top of the document
• Provides clear identification of the release at a glance

Improved Visual Spacing

• Added 4 blank lines between the "Improvements" section and "Version History" section
• This significant spacing ensures better visual separation between the release changes and the historical version information

Completed Build Artifacts Section

Previously, the Build Artifacts section was incomplete, showing only:

bin/<app_name>/<mode>/

Now includes:

• Clear explanation of the directory structure where executables are located after build
• Detailed descriptions of the <app_name> and <mode> variables
• Concrete examples for finding executables:
  • file_generator in debug mode: bin/file_generator/debug/
  • udp_replayer in release mode: bin/udp_replayer/release/

Added Version Checkout Instructions

Added a new section "Checking Out a Specific Version" with:

• Git command for checking out a specific tagged version: git checkout tags/v1.2.3.4
• Git command for returning to the main branch: git checkout main
• Clear explanation of what each command does

Result

The file now serves as a comprehensive example for developers creating release notes, providing all necessary information in a well-structured, easy-to-read format.

File Location: scripts/pipeline/release/sample_release_notes.md

Original prompt

implement this.
nd added support for app-specific builds.

• Release Notes Automation: Automated generation of release notes based on Git history.

Bug Fixes

• File Generator: Fixed an issue with out-of-source builds not resolving dependencies correctly.
• Build Script: Resolved a bug where the build number was incremented on failed builds.

Improvements

• Code Style: Enforced consistent formatting across all scripts.
• Documentation: Updated README with instructions for checking out specific versions.

---

---

Version History

Version	Date	Hash	Message	Author
v1.2.3.4	2025-10-16	cccd998	Updating release script	Bryan Camp
v1.2.3.4	2025-10-16	13cb37b	Updated release script	Bryan Camp
v1.2.3.4	2025-10-15	c18f67d	Updated version number	Bryan Camp
v1.2.3.4	2025-10-15	261a82e	Added release notes	Bryan Camp
v1.2.3.3	2025-10-14	b73b2d6	Updated top-level build scripts	Bryan Camp
v1.2.3.3	2025-10-13	6b8711b	Complete directory restructure	Bryan Camp
v1.2.3.3	2025-10-13	325b1b1	Added out-of-source build script	Bryan Camp

---

Checking Out a Specific Version

To check out a specific version of the Beacon project, use the following Git command:

git checkout tags/v1.2.3.4

This will give you a read-only view of the source code for that version. To return to the main branch, run:

git checkout main

---

Changes Made:

1. Added an Empty Header:
   • Added an empty header (###) between Improvements and Version History for clear separation.
2. Horizontal Rules:
   • Retained horizontal rules to further emphasize the separation.

Let me know if this achieves the desired separation or if you’d like further refinements!
User: Can I see hte markdown
AI: It seems you're asking to see the Markdown content of the
AI: file. However, the file content is not fully visible in the provided context. Could you clarify if you'd like me to generate a new
AI: based on our discussions, or if you'd like me to assist with specific sections of the file? Let me know how I can help!
User: There is simply not enough space between Information / Versions. I'm talking Information: /n/n/n/n/n/n/n Versions.
AI: Here’s the updated Markdown for the Release Notes with significant spacing (7 blank lines) added between Improvements and Version History to ensure they are visually distinct:

# Release Notes

## Release Version: `v1.2.3.4`
**Release Date**: 2025-10-16  
**Author**: Bryan Camp  

---

### Summary
This release includes updates to the build pipeline, optimizations for the file generator, and various bug fixes.

---

### Changes
#### New Features
- **Build Pipeline Enhancements**: Improved modularity and added support for app-specific builds.
- **Release Notes Automation**: Automated generation of release notes based on Git history.

#### Bug Fixes
- **File Generator**: Fixed an issue with out-of-source builds not resolving dependencies correctly.
- **Build Script**: Resolved a bug where the build number was incremented on failed builds.

#### Improvements
- **Code Style**: Enforced consistent formatting across all scripts.
- **Documentation**: Updated README with instructions for checking out specific versions.









---

### Version History

| Version   | Date       | Hash     | Message                          | Author          |
|-----------|------------|----------|----------------------------------|-----------------|
| v1.2.3.4  | 2025-10-16 | cccd998  | Updating release script          | Bryan Camp      |
| v1.2.3.4  | 2025-10-16 | 13cb37b  | Updated release script           | Bryan Camp      |
| v1.2.3.4  | 2025-10-15 | c18f67d  | Updated version number           | Bryan Camp      |
| v1.2.3.4  | 2025-10-15 | 261a82e  | Added release notes              | Bryan Camp      |
| v1.2.3.3  | 2025-10-14 | b73b2d6  | Updated top-level build scripts  | Bryan Camp      |
| v1.2.3.3  | 2025-10-13 | 6b8711b  | Complete directory restructure   | Bryan Camp      |
| v1.2.3.3  | 2025-10-13 | 325b1b1  | Added out-of-source build script | Bryan Camp      |

---

### Checking Out a Specific Version

To check out a specific version of the Beacon project, use the following Git command:

```bash
git checkout tags/v1.2.3.4

This will give you a read-only view of the source code for that version. To return to the main branch, run:

git checkout main

---

### Changes Made:
1. **Added 7 Blank Lines**:
   - Significant spacing was added between **Improvements** and **Version History** to ensure they are visually distinct.
2. **Corrected Git Checkout Command**:
   - Used `git checkout tags/v1.2.3...

</details>

Created from VS Code via the [GitHub Pull Request](https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-pull-request-github) extension.

<!-- START COPILOT CODING AGENT TIPS -->
---

✨ Let Copilot coding agent [set things up for you](https://github.com/BryWillow/Beacon/issues/new?title=✨+Set+up+Copilot+instructions&body=Configure%20instructions%20for%20this%20repository%20as%20documented%20in%20%5BBest%20practices%20for%20Copilot%20coding%20agent%20in%20your%20repository%5D%28https://gh.io/copilot-coding-agent-tips%29%2E%0A%0A%3COnboard%20this%20repo%3E&assignees=copilot) — coding agent works faster and does higher quality work when set up for your repo.