Skip to content

Commit

Permalink
Releases/v3.7 (#218)
Browse files Browse the repository at this point in the history
  • Loading branch information
dangoslen authored Nov 27, 2023
1 parent e281c12 commit 15b927c
Show file tree
Hide file tree
Showing 6 changed files with 29 additions and 23 deletions.
6 changes: 5 additions & 1 deletion .github/workflows/pull-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,15 @@ jobs:
with:
activationLabel: 'dependabot'

- uses: stefanzweifel/git-auto-commit-action@v5
- id: auto-commit
uses: stefanzweifel/git-auto-commit-action@v5
with:
commit_message: "Updated Changelog"

- id: changelog-enforcer
# If changes were detected, it would include a changelog
# Skip enforcing the changelog and wait for the next commit to trigger the workflow
if: steps.auto-commit.outputs.changes_detected == 'false'
uses: dangoslen/changelog-enforcer@v3
with:
expectedLatestVersion: ${{ steps.read_version.outputs.version }}
Expand Down
9 changes: 5 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@

Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)

## [UNRELEASED]
## [3.7.0]

### Added
- Now supports GitHub grouped updates. Each upgrade dependency will form a new line under the configured [section](./README.md#sectionheader) of the relevant release.
- Now supports [Dependabot multi-package updates](https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#groups). Each dependency upgrade will form a new line under the configured [section](./README.md#sectionheader) as if the upgrade was from it's own pull request.

### Dependencies
- Bump `@actions/github` from 5.1.0 to 6.0.0 ([#209](https://github.com/dangoslen/dependabot-changelog-helper/pull/209))
Expand All @@ -16,8 +17,8 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
- Bump `eslint-plugin-jest` from 27.2.2 to 27.6.0 ([#220](https://github.com/dangoslen/dependabot-changelog-helper/pull/220))

### Refactored
- Refactors how a changelog gets updated to allow for multiple entries to be written in one invocation of the GitHub Action. This is preparatory work to allow for multi-package updates
- Refactors `entry-extractor` to return an array of `DependabotEntry` values to update the changelog with. This is preparatory work to allow for multi-package updates
- Refactored how a changelog gets updated to allow for multiple entries to be written in one invocation of the action. This is preparatory work to allow for multi-package updates
- Refactored `entry-extractor` to return an array of `DependabotEntry` values to update the changelog with. This is preparatory work to allow for multi-package updates

## [3.6.0]
### Fixed
Expand Down
31 changes: 16 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,18 @@

## Dependabot Changelog Helper

This action helps you easily auto-update your changelog!
Automatically update your changelog on Dependabot pull requests! No more manually updating a changelog for dependency upgrades. Just fast and easy dependency upgrades.

### We all love Dependabot...

But it can feel overwhelming and require additional work to update things like versions and changelogs.

Built around the [KeepAChangelog](https://keepachangelog.com/) format, this action looks for an entry line for an updated package and either:
Built around the [KeepAChangelog](https://keepachangelog.com/) format, this action looks for upgraded dependencies on a Dependabot pull request and adds them to your changelog.

- 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).
- Handles adding the appropriate `### Dependencies` and/or `## [<version>]` sections if needed
- Supports multi-package updates in a single pull request
- Updates the entry for a dependency if the dependency had been upgraded previously in the same version
- Includes link(s) to associated pull requests that upgraded the dependency

### Usage

Expand Down Expand Up @@ -67,6 +58,16 @@ jobs:
commit_message: "Updated Changelog"
```
### 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).

### Inputs / Properties

Below are the properties you can use for the Dependabot Changelog Helper.
Expand Down
2 changes: 1 addition & 1 deletion dist/index.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion dist/index.js.map

Large diffs are not rendered by default.

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.6.0",
"version": "3.7.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 15b927c

Please sign in to comment.