From a35467c9cb03a8cce21a7e9d62bddc2ca39616e2 Mon Sep 17 00:00:00 2001
From: Dan Goslen <dwgoslen@gmail.com>
Date: Tue, 6 Jun 2023 15:09:42 -0400
Subject: [PATCH] Cutting v3.2.0 (#169)

* Cutting v3.2.0

* Correct version
---
 CHANGELOG.md |  5 +++++
 README.md    | 17 ++++++++++++++---
 package.json |  2 +-
 3 files changed, 20 insertions(+), 4 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 0dbf87e..0de0155 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -3,6 +3,11 @@
 Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
 ## [UNRELEASED]
+
+## [3.2.0]
+### Added
+- Provides better [documentation for the entry format](./README.md#entry-format)
+
 ### Dependencies
 - Bump `typescript` from 4.9.5 to 5.1.3 (#165)
 - Bump `eslint-plugin-github` from 4.7.0 to 4.8.0 (#166)
diff --git a/README.md b/README.md
index e314cf7..e9f5add 100644
--- a/README.md
+++ b/README.md
@@ -14,8 +14,19 @@ But it can feel overwhelming and require additional work to update things like v
 
 Built around the [KeepAChangelog](https://keepachangelog.com/) format, this action looks for an entry line for an updated package and either:
 
-- Add it if not found (including adding the `### Dependencies` and `## [<version>]` sections!)
-- Update it if the package has been upgraded after an initial entry was written
+- Adds an entry if not found (including adding the `### Dependencies` and `## [<version>]` sections!)
+- Updates the entry if one has been found within the same version. 
+  - This includes update the upgraded version and the associated pull request numbers
+
+### Entry Format
+
+The format for an entry is as follows
+
+```
+- <entryPrefix> <package> from <oldVersion> to <newVersion> (#pr-number[, #pr-number])`
+```
+
+The `<entryPrefix>` can be controlled via the [entry-prefix input](#entryprefix).
 
 ### Usage
 
@@ -92,4 +103,4 @@ This is a way to incrementally build a version over time and only release a vers
 | ------------ | ------------------------------------------------------------------------------------------------- |
 | `Bump`       | The starting word of a dependency bump entry line. Currently only supports single world prefixes. |
 
-The format of an entry is `- <entryPrefix> <package> from <oldVersion> to <newVersion>`. If a previous entry was written with a different entry (`Bump` vs `Bumps`), the entry will still get updated for updates within the same version as long as the prefix is a single word.
+If a previous entry was written with a different entry (`Bump` vs `Bumps`), the entry will still get updated for updates within the same version as long as the prefix is a single word. 
diff --git a/package.json b/package.json
index f65aa66..a99b050 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "dependabot-helper",
-  "version": "3.1.1",
+  "version": "3.2.0",
   "private": false,
   "description": "A GitHub Action to auto-add dependabot changes to your changelog and increment version numbers",
   "main": "lib/dependabot-helper.js",