Enhanced Commit Metadata & Documentation

Added print_commit_metadata function for consistent display of commit info
Updated template files with clearer instructions and new sections like "Announcement Request" and "Summary Request"
Fixed test cases in summarize_target.bats suite for more accurate validation

Author: itlackey

ANNOUNCEMENT.md

@@ -0,0 +1,38 @@
+# Introducing giv v1.0.3 – October 2024
+
+Exciting news! We're thrilled to announce the latest update to giv, packed with features that will enhance your experience and streamline your workflow.
+
+## What’s New
+
+### Improved Commit Metadata Display
+We've added a new function called `print_commit_metadata` in our helper tools. This addition ensures that commit information is displayed consistently across all platforms, making it easier for you to track changes and maintain project history.
+
+### Enhanced Documentation Templates
+Our documentation templates have received a major overhaul with clearer instructions and the introduction of new sections like "Announcement Request" and "Summary Request". These updates aim to provide you with more comprehensive guidance when working with giv.
+
+### More Reliable Testing
+We've corrected several test cases in our `summarize_target.bats` suite, ensuring they now properly validate output. This means that our tests are more accurate than ever before, giving you confidence in the reliability of giv's features.
+
+## Real-World Impact
+
+With these updates, users can expect a more seamless and consistent experience when working with giv. The enhanced documentation templates make it easier to understand and utilize the software effectively, while improved testing ensures that all features work as intended every time.
+
+Whether you're a developer looking for streamlined commit metadata display or a project manager needing comprehensive documentation, this update has something for everyone.
+
+## Getting Started
+
+Ready to experience these exciting updates? If you haven't already, download giv from our [website](https://giv.io/download). For existing users, simply upgrade to the latest version by running:
+
+```sh
+giv upgrade
+```
+
+## What’s Next?
+
+We're constantly working on new features and improvements. Keep an eye out for upcoming releases that will bring even more functionality and ease of use to giv.
+
+## Conclusion
+
+Don't miss out on these game-changing updates! Download or upgrade to giv v1.0.3 today and experience the difference for yourself. If you have any questions or feedback, feel free to reach out to our support team at [support@giv.io](mailto:support@giv.io).
+
+Happy coding! 🚀

src/helpers.sh

@@ -548,6 +548,16 @@ get_commit_date() {
     fi
 }
 
+print_commit_metadata() {
+    commit="$1"
+    commit_version="$(get_version_info "$commit" "$(find_version_file)")"
+    printf '**Project Title:*** %s\n' "$(get_project_title)"
+    printf '**Version:*** %s\n' "${commit_version}"
+    printf '**Commit ID:*** %s\n' "$commit"
+    printf '**Date:** %s\n' "$(get_commit_date "$commit")"
+    printf '**Message:** %s\n' "$(get_message_header "$commit")"
+}
+
 # Replaces every “[NAME]” in stdin with the contents of
 # the environment variable GIV_TOKEN_NAME (if set).
 #
@@ -677,18 +687,17 @@ build_history() {
     fi
 
     # header
-    printf '**Commit ID:*** %s\n' "$commit" >>"$hist"
+    printf '### Commit ID %s\n' "$commit" >>"$hist"
     printf '**Date:** %s\n' "$(get_commit_date "$commit")" >>"$hist"
-    msg=$(get_message_header "$commit")
-    printf '**Message:** %s\n' "$msg" >>"$hist"
-
     # version
     vf=$(find_version_file)
     [ -n "$vf" ] && print_debug "Found version file: $vf"
     [ -n "$vf" ] && {
         ver=$(get_version_info "$commit" "$vf")
         [ -n "$ver" ] && printf '**Version:** %s\n' "$ver" >>"$hist"
     }
+    msg=$(get_message_header "$commit")
+    printf '**Message:** %s\n' "$msg" >>"$hist"
 
     # diff
     diff_out=$(build_diff "$commit" "$diff_pattern" "$debug")
@@ -876,7 +885,7 @@ summarize_target() {
     if git rev-parse --verify "$target" >/dev/null 2>&1; then
         print_debug "Summarizing single commit: $target"
         summarize_commit "$target" "$gen_mode" >>"$summaries_file"
-        printf '\n' >>"$summaries_file"
+        printf '\n========================\n\n'  >>"$summaries_file"
         return
     fi
 
@@ -922,17 +931,9 @@ summarize_commit() {
     print_debug "Using summary prompt: ${summary_template}"
     printf '%s\n' "${summary_template}" >"${pr}"
     res=$(generate_response "${pr}" "${gen_mode}" "0.9" "32768")
-    # header
-
-    printf '**Project Title:*** %s\n' "$(get_project_title)" >"$res_file"
-    {
-        printf '**Version:*** %s\n' "${sc_version}"
-        printf '**Commit ID:*** %s\n' "$commit"
-        printf '**Date:** %s\n' "$(get_commit_date "$commit")"
-        printf '**Message:** %s\n' "$(get_message_header "$commit")"
-        printf '========================\n\n'
-    } >>"$res_file"
 
+    print_commit_metadata "$commit" >"$res_file"
+    printf '\n\n' >>"$res_file"
     echo "${res}" >>"${res_file}"
 
     printf '%s\n' "${res}"

templates/announcement_prompt.md

@@ -1,8 +1,14 @@
-# Summary of Changes
+# Announcement Request
 
+## Recent Changes
+
+```markdown
 [SUMMARY]
+```
+
+## Instructions
 
-Write one engaging blog post announcing the [VERSION] release of [PROJECT_TITLE], using the following guidelines:
+Write one engaging blog post announcing the recent changes to [PROJECT_TITLE], using the information in the [Recent Changes](#recent-changes) section and the following guidelines:
 
 1. Audience & Tone  
    • General audience interested in the software  
@@ -40,3 +46,4 @@ Write one engaging blog post announcing the [VERSION] release of [PROJECT_TITLE]
    • Ensure all technical details are translated into user-friendly language  
 
 [RULES]
+[EXAMPLE]

templates/final_summary_prompt.md

@@ -1,6 +1,13 @@
-[PROJECT_TITLE] [VERSION]
+# Summary Request
+Project: [PROJECT_TITLE] 
+
+
+## Recent Changes
 [SUMMARY]
-Write a structured, Keep a Changelog–style summary of the provided change summaries.
+
+## Instructions
+
+Write a structured, summary of the recent changes.
 
 1. Overview  
    - Begin with a section summarizing all of the changes, and the purpose and scope of these changes.

templates/message_prompt.md

@@ -1,4 +1,4 @@
-## Summary of Changes
+# Commit Message Request
 
 [SUMMARY]
 

templates/summary_prompt.md

@@ -1,5 +1,11 @@
-[PROJECT_TITLE] [VERSION]
+# Summary Request
+Project: [PROJECT_TITLE] 
+
+## Git Diff
 [SUMMARY]
+
+## Instructions
+
 Write a structured, Keep a Changelog–style summary of the provided git diff. Do not include any version headings or other releases—just one section of grouped changes with type prefixes for each list item.
 
 1. Overview  

tests/summarize_target.bats

@@ -5,11 +5,11 @@ setup() {
     TMP_REPO="$BATS_TEST_DIRNAME/.tmp/tmp_repo"
     rm -rf "$TMP_REPO"
     mkdir -p "$TMP_REPO"
-    cd "$TMP_REPO"
+    cd "$TMP_REPO" || exit 1
     git init -q
     git config user.name "Test"
     git config user.email "test@example.com"
-    
+
     # Make two commits
     echo "first" >a.txt
     git add a.txt
@@ -54,7 +54,7 @@ teardown() {
     run cat "$summaries"
     # lines: SUMMARIZE:--current MODE:mymode  then blank
     [ "${lines[0]}" = "SUMMARIZE:--current MODE:mymode" ]
-    [ -z "${lines[1]}" ]
+    [ -z "${lines[2]}" ]
 }
 
 @test "summarize single commit writes exactly that commit" {
@@ -63,7 +63,7 @@ teardown() {
     [ "$status" -eq 0 ]
     run cat "$summaries"
     [ "${lines[0]}" = "SUMMARIZE:$FIRST_SHA MODE:xyz" ]
-    [ -z "${lines[1]}" ]
+    [ -z "${lines[2]}" ]
 }
 @test "summarize two-dot range writes both commits" {
     summaries=$(mktemp)
@@ -151,9 +151,9 @@ teardown() {
     [ "$status" -eq 0 ]
 
     run grep -v '^$' "$summaries"
-
+    printf '%s\n' "$output"
     [ "$status" -eq 0 ]
-    [ "${#lines[@]}" -eq 1 ]
+    [ "${#lines[@]}" -eq 2 ]
     [ "${lines[0]}" = "SUMMARIZE:HEAD~1 MODE:x" ]
 }