Skip to content

Commit

Permalink
Cutting v3.2.0 (#169)
Browse files Browse the repository at this point in the history
* Cutting v3.2.0

* Correct version
  • Loading branch information
dangoslen authored Jun 6, 2023
1 parent e64235b commit a35467c
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 4 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down

0 comments on commit a35467c

Please sign in to comment.